Contacts

List contacts

get/contacts

Request

  • Base URL: https://www.sociahive.com/api/v1
  • URL: https://www.sociahive.com/api/v1/contacts
  • Auth: one of:
    • API key in header X-API-Key
    • OAuth 2 (authorization code, authorization URL /api/oauth/authorize, token URL /api/oauth/token, scopes: contacts:read)

Query parameters

limitinteger
offsetinteger nullable
platform'instagram' | 'messenger' | 'whatsapp' | 'linkedin' | 'twitter' | 'tiktok' | 'telegram' | 'threads' | 'youtube' | 'bluesky' | 'pinterest' | 'facebook'

Connected-account platform identifier

Response

Contacts page

Example response

{
  "data": {
    "contacts": [
      {
        "_id": "507f1f77bcf86cd799439011"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.