@archastro/sdk
    Preparing search index...

    Interface AgentListResponse

    Paginated list of agent objects. Use the pagination fields to traverse multiple pages of results.

    interface AgentListResponse {
        data: Agent[];
        has_next?: boolean;
        has_prev?: boolean;
        page?: number;
        page_size?: number;
        total_entries?: number;
        total_pages?: number;
    }
    Index

    Properties

    data has_next? has_prev? page? page_size? total_entries? total_pages?

    Properties

    data: Agent[]

    Array of agent objects for the current page.

    has_next?: boolean

    true when a subsequent page of results exists.

    has_prev?: boolean

    true when a previous page of results exists.

    Optionalpage

    page?: number

    Current page number, starting at 1.

    Optionalpage_size

    page_size?: number

    Maximum number of agents returned per page.

    total_entries?: number

    Total number of agents matching the query across all pages.

    total_pages?: number

    Total number of pages available given the current page_size.

    Settings

    Member Visibility

    On This Page

    Properties