Sign in
Social Accounts

List Social Accounts

Lists the social accounts linked to an account or user.

get/social_accounts

Query parameters

account_idstring

The Account that the social accounts are connected to. Provide either this or user_id.

user_idstring

The User that the social accounts are connected to. Provide either this or account_id.

platform'x' | 'instagram' | 'youtube' | 'tiktok' | 'facebook' | 'discord' | 'telegram'

Only return social accounts for the platform that is specified.

verifiedboolean

Only return social accounts that are verified on the platform.

scopesstring[]

Only return social accounts that have these scopes.

firstinteger

The number of social accounts to return.

afterstring

Cursor to fetch the page after (from page_info.end_cursor).

lastinteger

The number of social accounts to return from the end of the range.

beforestring

Cursor to fetch the page before (from page_info.start_cursor).

order'display_order' | 'created_at'

The field to sort social accounts by.

direction'asc' | 'desc'

Sort direction.

Response

filtered to accounts holding the requested scope

Example response

{
  "data": [
    {
      "error": "You don't have permission to share this account. Ask an admin of its Meta Business Portfolio to grant you full control, then share it again.",
      "external_id": "1234567891",
      "id": "sacc_xxxxxxxxxxxxxx",
      "name": "Shine Time Auto Detailing",
      "parent_social_account": {
        "external_id": "555111",
        "id": "sacc_xxxxxxxxxxxxxx",
        "name": "Shine Time Auto Detailing",
        "platform": "facebook",
        "profile_picture_url": "https://shinetime.example/logo.png",
        "username": "shinetimedetailing",
        "verified": true
      },
      "platform": "instagram",
      "profile_picture_url": "https://shinetime.example/logo.png",
      "scopes": [
        "advertise"
      ],
      "url": "https://instagram.com/shinetimedetail",
      "username": "shinetimedetail",
      "verified": true
    }
  ],
  "page_info": {
    "end_cursor": "WyJjdXJzb3IiLDFd",
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

Changed in 4 of the 41 revisions of this API.226

  • a01100378e591See the full diff
    • ○

      added the required property data/items/parent_social_account to the response with the 200 status

      response-required-property-added

  • f1020c3ecda42See the full diff
    • ○

      added the optional property error/code to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property error/code to the response with the 401 status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 60bbb4a6ffbc23See the full diff
    • ●

      added the new discord enum value to the data/items/platform response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new telegram enum value to the data/items/platform response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new enum value discord to the query request parameter platform

      request-parameter-enum-value-added

    • ○

      added the new enum value telegram to the query request parameter platform

      request-parameter-enum-value-added

    • ○

      added the required property data/items/error to the response with the 200 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3a06a605784b2See the full diff
    • ▲

      the response property data/items/url became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/username became nullable for the status 200

      response-property-became-nullable