Skip to main content

CustomerSearchArguments

Search criteria for filtering and retrieving customers with pagination, sorting, and date range filtering capabilities

input CustomerSearchArguments {
  customerIds: [Int!]
  term: String
  termFields: [CustomerTermField!]
  debtorIds: [String!]
  firstName: String
  middleName: String
  lastName: String
  email: String
  gender: Gender
  page: Int
  offset: Int
  sort: [CustomerSortInput!]
  lastModifiedAt: DateSearchInput
  createdAt: DateSearchInput
  sources: [SourceSearchInput!]
}

Fields​

CustomerSearchArguments.customerIds ● [Int!] list scalar​

Internal customer identifiers for precise customer lookup. All IDs must be unique integers for accurate filtering.

CustomerSearchArguments.term ● String scalar​

Free-text search term matched as a case-insensitive substring across the customer's own fields. The *_ID fields match by exact id (numeric terms only). Restrict the searched fields with termFields. Multi-word terms must all match (AND). Each token must be at least 3 characters, or a numeric id.

CustomerSearchArguments.termFields ● [CustomerTermField!] list enum​

Fields the term searches. Text fields match by case-insensitive substring; the *_ID fields match by exact id (numeric terms only). When omitted, the customer's own fields are searched.

CustomerSearchArguments.debtorIds ● [String!] list scalar​

External debtor system identifiers for financial integration and billing system lookup. Each debtor ID must be unique and maximum 100 characters.

CustomerSearchArguments.firstName ● String scalar​

Customer's first name for personal identification search. Maximum 100 characters for precise matching.

CustomerSearchArguments.middleName ● String scalar​

Customer's middle name or initial for complete personal identification search. Maximum 50 characters for precise matching.

CustomerSearchArguments.lastName ● String scalar​

Customer's last name for personal identification search. Maximum 50 characters for precise matching.

CustomerSearchArguments.email ● String scalar​

Primary email address for customer identification and communication lookup. Must be valid email format for accurate matching.

CustomerSearchArguments.gender ● Gender enum​

Customer's gender for demographic filtering and personalized service identification

CustomerSearchArguments.page ● Int scalar​

Page number for paginated results. Defaults to 1 for first page of results.

CustomerSearchArguments.offset ● Int scalar​

Number of results per page for pagination. Minimum 1, maximum 100 results per page for optimal performance.

CustomerSearchArguments.sort ● [CustomerSortInput!] list input​

Sorting criteria for organizing search results by multiple fields with ascending or descending order

CustomerSearchArguments.lastModifiedAt ● DateSearchInput input​

Date range filter for customer records based on last modification timestamp for change tracking and audit purposes

CustomerSearchArguments.createdAt ● DateSearchInput input​

Date range filter for customer records based on creation timestamp for historical data analysis and reporting

CustomerSearchArguments.sources ● [SourceSearchInput!] list input​

Data source filtering for tracking customer data origin and integration points for compliance and audit purposes

Member Of​

customers query