Archive API docs
    Jump to

    Narrow by kind with a prefix — q: queries, m: mutations, t: types, g: guides, f: fields and arguments.

    Jump to examples ↓
    Query

    socialProfile

    Return details for a social profile by ID or account identifier.

    **Errors:** When fallback: true triggers a live lookup and the upstream social-platform service returns a transient failure, this query returns a GraphQL error with extensions.code = "UPSTREAM_UNAVAILABLE" and extensions.provider set to the requested platform. Clients should treat this as retriable (the upstream blip is usually short-lived); switch on the stable extensions.code rather than the message text.

    Arguments

    Object, input and enum types open in place — use + to reveal their fields. A type that is already open above the row stops at a ↻ circular marker, and anything nested past the depth limit links out to its own page instead.

    accountName String
    Username or handle on the social platform (e.g., "nike" for instagram.com/nike).
    fallback Boolean default false
    When true, fetches profile from social platform if not archived locally. May increase response time.
    id ID
    Unique identifier of the social profile within your workspace.
    provider Provider
    Social platform: instagram, tiktok, or youtube. Required when using account_name.

    Returns

    Returns SocialProfile .

    accountName String!
    Username or handle of the social media account.
    avatar String
    URL of the account's profile picture, if available.
    creator Creator
    Creator associated with this social profile in the current workspace. Use this to get the unified creator ID for deduplicating creators across platforms. Returns null if the profile has no creator record in this workspace.
    email String
    Email address associated with the account, if available.
    followers Int!
    Number of followers on the social media account (when available).
    following Int!
    Number of accounts this profile is following (when available).
    fullName String
    Display name or full name shown on the social media profile.
    id ID!
    Unique identifier of the social profile in Archive's system.
    originalUrl String!
    Direct URL to the profile on the social platform (e.g., https://instagram.com/account_name).
    phoneNumbers [String!]
    Phone numbers associated with the account, when present.
    private Boolean!
    Whether the social media account is currently set to private.
    proAccount Boolean!
    Whether the account is marked as a professional or business account on the platform.
    provider Provider!
    Platform where the social profile exists (for example INSTAGRAM, TIKTOK, YOUTUBE, or INTERNAL).
    verified Boolean!
    Whether the account has a verified/badge status on the platform.