getAllCustomers
Retrieve customer data using specific filters such as IDs, emails, names, loyalty codes, or date ranges. At least one filter is required; defaults to active customers if none provided. Supports pagination and data extent selection.
Instructions
Get customers with filters. Note: At least one filter must be provided (CustomerIds, Emails, FirstNames, LastNames, LoyaltyCodes, CompanyIds, CreatedUtc, UpdatedUtc, or DeletedUtc). If no filters are specified, defaults to ActivityStates: ["Active"] to return all active customers. IMPORTANT LIMITATIONS: Date range filters (CreatedUtc, UpdatedUtc, DeletedUtc) have a maximum interval of 3 months and 1 day. All array filters have specific maximum item limits (typically 1000, except CompanyIds which is limited to 1).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ActivityStates | No | Whether to return only active, only deleted or both records | |
| ChainIds | No | Unique identifiers of the chains. Required when using Portfolio Access Tokens, ignored otherwise. | |
| CompanyIds | No | Unique identifier of the Company the customer is associated with | |
| CreatedUtc | No | Interval in which Customer was created (max length 3 months) | |
| CustomerIds | No | Unique identifiers of Customers. Required if no other filter is provided. | |
| DeletedUtc | No | Interval in which Customer was deleted (max length 3 months) | |
| Emails | No | Emails of the Customers | |
| Extent | No | Extent of data to be returned | |
| FirstNames | No | First names of the Customers | |
| LastNames | No | Last names of the Customers | |
| Limitation | No | Limitation on the quantity of data returned | |
| LoyaltyCodes | No | Loyalty codes of the Customers | |
| UpdatedUtc | No | Interval in which Customer was updated (max length 3 months) |
Input Schema (JSON Schema)
{
"properties": {
"ActivityStates": {
"description": "Whether to return only active, only deleted or both records",
"items": {
"type": "string"
},
"type": "array"
},
"ChainIds": {
"description": "Unique identifiers of the chains. Required when using Portfolio Access Tokens, ignored otherwise.",
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
},
"CompanyIds": {
"description": "Unique identifier of the Company the customer is associated with",
"items": {
"type": "string"
},
"maxItems": 1,
"type": "array"
},
"CreatedUtc": {
"description": "Interval in which Customer was created (max length 3 months)",
"properties": {
"EndUtc": {
"description": "End of creation date range (ISO 8601)",
"type": "string"
},
"StartUtc": {
"description": "Start of creation date range (ISO 8601)",
"type": "string"
}
},
"type": "object"
},
"CustomerIds": {
"description": "Unique identifiers of Customers. Required if no other filter is provided.",
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
},
"DeletedUtc": {
"description": "Interval in which Customer was deleted (max length 3 months)",
"properties": {
"EndUtc": {
"description": "End of deletion date range (ISO 8601)",
"type": "string"
},
"StartUtc": {
"description": "Start of deletion date range (ISO 8601)",
"type": "string"
}
},
"type": "object"
},
"Emails": {
"description": "Emails of the Customers",
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
},
"Extent": {
"description": "Extent of data to be returned",
"properties": {
"Addresses": {
"description": "Whether the response should contain addresses of customers",
"type": "boolean"
},
"Customers": {
"description": "Whether the response should contain information about customers",
"type": "boolean"
},
"Documents": {
"description": "Whether the response should contain identity documents of customers (deprecated)",
"type": "boolean"
}
},
"type": "object"
},
"FirstNames": {
"description": "First names of the Customers",
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
},
"LastNames": {
"description": "Last names of the Customers",
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
},
"Limitation": {
"description": "Limitation on the quantity of data returned",
"properties": {
"Count": {
"description": "Maximum number of customers to return",
"type": "number"
},
"Cursor": {
"description": "Pagination cursor for next page",
"type": "string"
}
},
"type": "object"
},
"LoyaltyCodes": {
"description": "Loyalty codes of the Customers",
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
},
"UpdatedUtc": {
"description": "Interval in which Customer was updated (max length 3 months)",
"properties": {
"EndUtc": {
"description": "End of update date range (ISO 8601)",
"type": "string"
},
"StartUtc": {
"description": "Start of update date range (ISO 8601)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}