Inbox · Instagram

List the collaborators of an Instagram post

Returns the collaborators of an Instagram post.

GEThttps://api.pozy.ai/v1/accounts/{accountId}/instagram/media/{mediaId}/collaborators
listInstagramMediaCollaborators

Guide: Instagram

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the publishing resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

NameTypeNotes
accountIdrequiredstring
mediaIdrequiredstringMatches ^[0-9]+$

Example

curl -X GET "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/instagram/media/69eaa09f981d518a7e5ab560/collaborators" \
  -H "Authorization: Bearer $POZY_API_KEY"

Response

200 on success

  • dataarray of objectrequired

    Up to 5 items.

    • idstringrequired
    • usernamestringrequired

      Can be null.

    • inviteStatusstringrequired

      Can be null.

200 response
{
  "data": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "username": "acme",
      "inviteStatus": "active"
    }
  ]
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is scoped to other profiles or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Instagram