@adcp/sdk API Reference - v14.0.0-beta.6
    Preparing search index...

    Interface ListAccountsRequest

    Request parameters for listing accounts accessible to the authenticated agent. For upstream-managed namespaces, this discovers seller/storefront account_id values. For buyer-declared accounts, responses return the natural-key fields needed to reconstruct an AccountRef after a cold start.

    interface ListAccountsRequest {
        adcp_version?: string;
        adcp_major_version?: number;
        account?: AccountReference;
        status?:
            | "active"
            | "pending_approval"
            | "rejected"
            | "payment_required"
            | "suspended"
            | "closed";
        pagination?: PaginationRequest;
        sandbox?: boolean;
        include_webhook_activity?: boolean;
        webhook_activity_limit?: number;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    adcp_version?: string

    Release-precision AdCP version (VERSION.RELEASE, e.g. "3.0", "3.1", "3.1-beta"). On a request: the buyer's release pin — the seller validates against its supported_versions and returns VERSION_UNSUPPORTED on cross-major mismatch, or downshifts to the highest supported release within the same major. On a response: the release the seller actually served — clients SHOULD validate the response against that release's schema, not against their pin. Patches are not negotiated; surface them as build_version on capabilities for operational visibility. When omitted, falls back to adcp_major_version (deprecated) or server default. Buyers SHOULD emit both adcp_version and adcp_major_version through 3.x to remain compatible with sellers that only read the legacy field. NORMALIZATION: SDKs that read full-semver values from bundle metadata (e.g. ComplianceIndex.published_version = "3.1.0-beta.1") MUST normalize to release-precision ("3.1-beta.1") before emitting on the wire — meta-field values are NOT valid wire values.

    adcp_major_version?: number

    DEPRECATED in favor of adcp_version (release-precision string). Servers MUST continue to honor this field through 3.x. Removed in 4.0. Original semantics: the AdCP major version the buyer's payloads conform to. Sellers validate against their supported major_versions and return VERSION_UNSUPPORTED if unsupported. When omitted, the seller assumes its highest supported version.

    status?:
        | "active"
        | "pending_approval"
        | "rejected"
        | "payment_required"
        | "suspended"
        | "closed"

    Filter accounts by status. Omit to return accounts in all statuses.

    pagination?: PaginationRequest
    sandbox?: boolean

    Filter by sandbox status. true returns only sandbox accounts, false returns only production accounts. Omit to return all accounts. Primarily used with account-id namespaces where sandbox accounts are pre-existing test accounts on the platform.

    include_webhook_activity?: boolean

    When true, request recent webhook delivery attempts for each returned account in account.webhook_activity[]. Sellers MAY omit webhook_activity if they do not expose this debug log; when present, three-state semantics match the shared webhook_activity[] contract.

    webhook_activity_limit?: number

    Maximum number of webhook_activity[] records to return per account when include_webhook_activity is true.

    1

    200

    context?: ContextObject