getcustomersrequest.md

GetCustomersRequest

Example Usage

import { GetCustomersRequest } from "dub/models/operations";

let value: GetCustomersRequest = {
  pageSize: 50,
};

Fields

Field	Type	Required	Description	Example
email	string	➖	A case-sensitive filter on the list based on the customer's email field. The value must be a string. Takes precedence over externalId.
externalId	string	➖	A case-sensitive filter on the list based on the customer's externalId field. The value must be a string. Takes precedence over search.
search	string	➖	A search query to filter customers by email, externalId, or name. If email or externalId is provided, this will be ignored.
country	string	➖	A filter on the list based on the customer's country field.
linkId	string	➖	A filter on the list based on the customer's linkId field (the referral link ID).
programId	string	➖	Program ID to filter by.
partnerId	string	➖	Partner ID to filter by.
includeExpandedFields	boolean	➖	Whether to include expanded fields on the customer (link, partner, discount).
sortBy	operations.GetCustomersQueryParamSortBy	➖	The field to sort the customers by. The default is createdAt.
sortOrder	operations.GetCustomersQueryParamSortOrder	➖	The sort order. The default is desc.
page	number	➖	The page number for pagination.	1
pageSize	number	➖	The number of items per page.	50