Instagram Collaborator Request Status

GEThttps://api.acme.com/api/post/collaborators/:id

Available on Premium, Business, Enterprise plans.

When you invite a collaborator to a post, you can check the status of the request using this endpoint. Only Instagram users who have enabled collaborator tagging will be returned in the response.

Header Parameters

Authorizationstringrequired

API Key of the Primary Profile.

Format: Authorization: Bearer API_KEY

Profile-Keystring

Profile Key of a User Profile.

Format: Profile-Key: PROFILE_KEY

Path Parameters

idstringrequired

In the path parameter, use an ID Type

Query Parameters

searchPlatformIdbooleanrequired

Set to true. Required if using a Social Post ID.

200

{
  "collaborators": [
    {
      "id": "17841401319910272",
      "username": "acme",
      "inviteStatus": "accepted"
    },
    {
      "id": "17841401319910273",
      "username": "acme1",
      "inviteStatus": "declined"
    },
    {
      "id": "17841401319910274",
      "username": "acme2",
      "inviteStatus": "pending"
    }
  ],
  "lastUpdated": "2024-03-08T04:08:18.979Z",
  "nextUpdate": "2024-03-08T04:09:18.979Z"
}

400

{
  "action": "analytics",
  "status": "error",
  "code": 294,
  "message": "Error getting analytics."
}