Mayson Monorepo Documentation
    Preparing search index...

    Interface CustomerSearchParams

    interface CustomerSearchParams {
        query: string;
        expand?: string[];
        limit?: number;
        page?: string;
    }
    Index

    Properties

    query expand? limit? page?

    Properties

    query: string

    The search query string. See search query language and the list of supported query fields for customers.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    limit?: number

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    Optionalpage

    page?: string

    A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

    Settings

    Member Visibility

    On This Page

    Properties