Interface GetCustomersQueryParams

Query parameters for listing customers.

interface GetCustomersQueryParams {
    cursor?: string;
    filter?: readonly CustomerFilter[];
    limit?: number;
    sort?: GetCustomersSort;
}

Hierarchy

CursorPaginationQueryParams
- GetCustomersQueryParams

Index

Properties

cursor? filter? limit? sort?

Properties

`Optional` `Readonly`cursor

cursor?: string

Cursor for pagination. Use this to fetch the next set of results.

`Optional` `Readonly`filter

filter?: readonly CustomerFilter[]

Filter customers by specific fields. API format: JSON array serialized into a query string.

`Optional` `Readonly`limit

limit?: number

Number of items to return per request (between 1 and 100).

`Optional` `Readonly`sort

sort?: GetCustomersSort

Sort customers by id. Use -id for descending order.