Snapvisor Docs

Get an account

Retrieve an account with its plan and current-period usage. Use it to watch screenshot consumption against the plan before it runs over.

GET
/accounts/{accountSlug}

Retrieve an account with its plan and current-period usage. Use it to watch screenshot consumption against the plan before it runs over.

Authorization

AuthorizationBearer <token>

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

In: header

Path Parameters

accountSlug*string

Slug of the account to retrieve.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/accounts/string"
{  "id": "string",  "slug": "string",  "name": "string",  "type": "user",  "plan": {    "name": "string",    "includedScreenshots": -9007199254740991  },  "periodStartDate": "2019-08-24T14:15:22Z",  "periodEndDate": "2019-08-24T14:15:22Z",  "currentPeriodScreenshots": -9007199254740991,  "includedScreenshots": -9007199254740991,  "consumptionRatio": 0,  "additionalScreenshotsCost": 0,  "defaultUserLevel": "member"}