contacts
Search customers and companies together as a single unified list.
Deleted records are always excluded. When usageType is "autoComplete" and searchValue contains one or more comma-separated email addresses, exact email matches are returned first, ahead of the regular paginated results.
Auth · x-app-token · required permission showCustomers
Related: Pagination
contacts(page: Int, perPage: Int, searchValue: String, fieldsMustExist: [String], sortField: String, sortDirection: SortDirection, usageType: String): ContactsResponseArguments
1-based page index. Default: 1. See Pagination.
Page size. Default: 20. See Pagination.
Free-text search matched against each record's indexed search text.
When usageType is "autoComplete", also matched as one or more
comma-separated exact email addresses.
Only return records where every named field exists and is non-empty.
Field to sort by. Default: createdAt.
Sort direction, asc or desc. Default: desc.
Set to "autoComplete" to enable exact-email matching against searchValue
(see above). Omit for regular search behavior.
Returns
Standard pagination metadata: totalCount, currentPage, totalPages,
hasNextPage, hasPreviousPage, perPage.