tebarDocs
GuideDevelopersAPI ReferenceChangelog
Inbox

A person's Instagram profile and follow status

GET
/v1/accounts/{id}/contacts/{platform_id}

Reads from Instagram (User Profile API) whether the person follows the account and the account follows them, with their name, username, picture, follower count and verified badge; the answer is kept 10 minutes. platform_id is the person's Instagram id for this account, as in a conversation's contact.platform_id or a message.received webhook. Instagram tells only about people who messaged the account, or tapped an ice breaker or its menu: otherwise 200 with available false and unavailable_reason. At most 300 reads from Instagram an hour per account (429 rate_limited; kept answers do not count). Instagram accounts with the messaging permission only (422 messaging_permission_missing).

Requires the read scope.

Authorization

bearer
headerAuthorizationBearer <token>

An API key (tb_live_...) from the dashboard, or an OAuth access token.

Path Parameters

id*string
Formatuuid
platform_id*string

Header Parameters

Tebar-Profile?string

Limits an owner key to one profile (id or external_id). Unknown: 404 profile_not_found.

Response Body

The profile.

application/json
  1. response
platform_id*string

The customer's Instagram id for this account.

username*string|null
name*string|null
avatar_url*|

Instagram's signed URL; expires within days.

follower_count*integer|null
follows_you*|

null: Instagram tells only once the person has messaged the account.

verified*boolean|null
account_id*string
Formatuuid
available*boolean

false: Instagram does not tell about this person (see unavailable_reason).

unavailable_reason*|

no_consent: the person has not messaged the account (nor tapped an ice breaker or its menu). unavailable: Instagram cannot find them for this account (blocked it, gone, or an id from elsewhere).

followed_by_you*|

Whether the account follows the person.

conversation_id*|

The DM conversation with this person, when Tebar has it.

fetched_at*string

When Instagram was asked (answers are kept 10 minutes).

Formatdate-time
Example Request
curl -X GET 'https://api.tebar.app/v1/accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08/contacts/string'
Example Response
{
  "platform_id": "string",
  "username": "string",
  "name": "string",
  "avatar_url": "string",
  "follower_count": 0,
  "follows_you": true,
  "verified": true,
  "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  "available": true,
  "unavailable_reason": "no_consent",
  "followed_by_you": true,
  "conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407",
  "fetched_at": "2019-08-24T14:15:22Z"
}