@adcp/client API Reference - v4.19.0
    Preparing search index...

    Interface ListAccountsRequest

    Request parameters for listing accounts accessible to the authenticated agent

    interface ListAccountsRequest {
        status?:
            | "active"
            | "pending_approval"
            | "rejected"
            | "payment_required"
            | "suspended"
            | "closed";
        pagination?: PaginationRequest;
        sandbox?: boolean;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    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 explicit accounts (require_operator_auth: true) where sandbox accounts are pre-existing test accounts on the platform.

    context?: ContextObject
    ext?: ExtensionObject