API referenceAccounts

GET /api/v1/accounts/{id}

Get an account

GET
/api/v1/accounts/{id}

Authorization

BearerAuth
headerAuthorizationBearer <token>

API key sk_...

Path Parameters

id*string

Account id

Response Body

{account}

application/json
  1. response
account?
Example Request
curl -X GET 'https://example.com/api/v1/accounts/string'
Example Response
{  "account": {    "id": "string",    "platform": "instagram",    "accountName": "string",    "platformAccountId": "string",    "requireApproval": true,    "externalId": "string",    "status": "active",    "lastError": "string",    "tokenExpiresAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z"  }}

GET /api/v1/accounts/health GET

Health of every account (token validity, missing permissions, publishing limit, recommendations; cached 10 minutes)

PATCH /api/v1/accounts/{id} PATCH

Update the account: any of externalId, displayName, username (display overrides) and profileId (move to another profile; null detaches). null or "" clears a field