| Field | Type | Required | Description |
|---|---|---|---|
organizationId |
string|array|null | ➖ | Filter by organization ID. |
email |
?string | ➖ | Filter by exact email. |
query |
?string | ➖ | Filter by name or email. |
page |
?int | ➖ | Page number, defaults to 1. |
limit |
?int | ➖ | Size of a page, defaults to 10. Maximum is 100. |
sorting |
array<Components\CustomerSortProperty> | ➖ | Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order. |
metadata |
array<string, string|int|bool|array> | ➖ | Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value. |