customers
List customers for this workspace with filtering, segmentation, and conformity context, newest first.
Each row is a Customer. Use customerDetail for one
record, customerCounts for aggregate counts, or
customersAdd to create one.
Auth · x-app-token · required permission showCustomers
Related: customerDetail, customerCounts, customersAdd, Authentication
customers(page: Int, perPage: Int, segmentV2Id: String, type: String, types: [String], tag: String, ids: [String], excludeIds: Boolean, searchValue: String, autoCompletion: Boolean, autoCompletionType: String, integration: String, form: String, startDate: String, endDate: String, leadStatus: String, sortField: String, sortDirection: SortDirection, sex: Int, birthDate: Date, dateFilters: String, emailValidationStatus: String, conformityMainType: String, conformityMainTypeId: String, conformityRelType: String, conformityIsRelated: Boolean, conformityIsSaved: Boolean): CustomersListResponseArguments
1-based page index. Default: 1. See Pagination.
Page size. Default: 20. See Pagination.
Restrict results to members of one segments-v2 segment.
Filter by a single record type/pipeline (implementation-defined).
Filter by multiple record types/pipelines.
Filter by Tag id — only customers carrying that tag.
Restrict results to these specific customer ids.
When true, invert ids to exclude those customers instead of including them.
Case-insensitive partial match across name/email/phone fields.
When true, run a lighter-weight query suited for search-as-you-type UIs.
Field to autocomplete against when autoCompletion is true.
Filter by originating integration id.
Filter by the id of the form that captured this customer.
Only include customers created on/after this date (ISO string).
Only include customers created on/before this date (ISO string).
Filter by lead pipeline stage code.
Field name to sort by.
Sort direction paired with sortField.
Filter by sex code.
Filter by exact birth date.
Additional date-range filters as a JSON-encoded string.
Filter by email verification status.
Content type owning the relation (e.g. "customer"). Used with conformityMainTypeId to scope results to companies related to a Customer or other entity.
Id of the related record identified by conformityMainType.
Content type on this side of the relation (defaults to "company").
When true, only return companies related to the given main type/id.
When true, only return companies already saved against the relation.
Returns
Standard pagination metadata: totalCount, currentPage, totalPages,
hasNextPage, hasPreviousPage, perPage.