Accounts & connections · Accounts

Check whether an Instagram user follows the account

Checks whether an Instagram user follows the account. Works with Instagram accounts.

GEThttps://api.pozy.ai/v1/accounts/{accountId}/follow-status/{userId}

InstagramgetInstagramFollowStatus

Request

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

Path parameters

Name	Type	Notes
`accountId`required	string
`userId`required	string

Query parameters

Name	Type	Notes
`refresh`	boolean

Example

curl -X GET "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/follow-status/6da95b9455a22c1e061837af" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/follow-status/6da95b9455a22c1e061837af", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/follow-status/6da95b9455a22c1e061837af",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

userIdstringrequired
accountIdstringrequired
isFollowerbooleanrequired
Can be null.
isFollowedByAccountboolean
Can be null.
followerCountinteger
Can be null.
isVerifiedboolean
Can be null.
usernamestring
Can be null.
namestring
Can be null.
unavailableReasonstring
One of consent_required, dm_access_disabled, not_messageable, error. Can be null.

200 response

{
  "userId": "6da95b9455a22c1e061837af",
  "accountId": "696e0b682d0a31188e7a2ba9",
  "isFollower": true,
  "isFollowedByAccount": true,
  "followerCount": 42,
  "isVerified": true,
  "username": "acme",
  "name": "Acme",
  "unavailableReason": "consent_required"
}

Errors

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

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.