Hanzo
OpenapiSocial

Returns the org's connected accounts — each one's id, network, handle, status…

Returns the org's connected accounts — each one's id, network, handle, status and timestamps, most-recently-updated first.

GET /v1/social/accounts

Addresshttps://api.hanzo.ai/v1/social/accounts
MethodGET
Operationget_social_accounts
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the org's connected accounts — each one's id, network, handle, status and timestamps, most-recently-updated first.

An account's provider access token is NEVER included in any response on this surface. Only the publisher reads it.

Request

2 fields.

FieldInTypeRequiredDescription
providerquerystringProvider keeps only accounts on one network — x, facebook, instagram, linkedin, tiktok, youtube or threads. Omit it for every network.
limitquerystringLimit bounds the page, defaulting to 200 and capped at 1000.

Response

StatusBodyMeaning
200socialAccountsok

200 body — 7 fields.

FieldInTypeAlwaysDescription
databodysocialAccount[]Data is the accounts, most-recently-updated first, bounded by the limit.
data[].createdAtbodyintegerCreatedAt is when the account was connected, as a unix timestamp in seconds.
data[].handlebodystringHandle is the account's public name on the network, as the customer knows it.
data[].idbodystringID is the account's identifier, minted on connect and the id every later call addresses it by.
data[].providerbodystringProvider is the network this account is on: x, facebook, instagram, linkedin, tiktok, youtube or threads.
data[].statusbodystringStatus is the connection lifecycle: connected, disconnected or error.
data[].updatedAtbodyintegerUpdatedAt is when the account row last changed, as a unix timestamp in seconds.

Failure carries the platform error shape — see Errors.

Examples

hanzo social accounts list

Social API · All Hanzo APIs · Interactive reference

How is this guide?

On this page