# Customers Retrieve customers which match a specified criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#CustomerRepositoryInterface to determine which call to use to get detailed information about all attributes for an object. ## Documentation Retrieve customers which match a specified criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#CustomerRepositoryInterface to determine which call to use to get detailed information about all attributes for an object. - Catalog: `Magento` - Schema: `Customers` - Primary Keys: `id` Can retrieve data and change data using insert, update and delete. ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `Customers`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values. Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three. Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third. | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `searchCriteria[currentPage]` | `` | ☐ | | Current page. | | `searchCriteria[filterGroups][0][filters][0][conditionType]` | `` | ☐ | | Condition type | | `searchCriteria[filterGroups][0][filters][0][field]` | `` | ☐ | | Field | | `searchCriteria[filterGroups][0][filters][0][value]` | `` | ☐ | | Value | | `searchCriteria[pageSize]` | `` | ☐ | | Page size. | | `searchCriteria[sortOrders][0][direction]` | `` | ☐ | | Sorting direction. | | `searchCriteria[sortOrders][0][field]` | `` | ☐ | | Sorting field. | ## Columns of Table Function The columns of the table function `Customers` are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `confirmation` | `varchar2` | | ☐ | Confirmation | | `created_at` | `varchar2` | | ☐ | Created at time | | `created_in` | `varchar2` | | ☐ | Created in area | | `default_billing` | `varchar2` | | ☐ | Default billing address id | | `default_shipping` | `varchar2` | | ☐ | Default shipping address id | | `disable_auto_group_change` | `int64` | | ☐ | Disable auto group change flag. | | `dob` | `varchar2` | | ☐ | In keeping with current security and privacy best practices, be sure you are aware of any potential legal and security risks associated with the storage of customers’ full date of birth (month, day, year) along with other personal identifiers (e.g., full name) before collecting or processing such data. | | `email` | `varchar2` | | ☐ | Email address | | `extension_attributes_assistance_allowed` | `int64` | | ☐ | | | `extension_attributes_is_subscribed` | `char` | | ☐ | | | `firstname` | `varchar2` | | ☐ | First name | | `gender` | `int64` | | ☐ | Gender | | `group_id` | `int64` | | ☐ | Group id | | `id` | `int64` | | ☐ | Customer id | | `lastname` | `varchar2` | | ☐ | Last name | | `middlename` | `varchar2` | | ☐ | Middle name | | `prefix` | `varchar2` | | ☐ | Prefix | | `store_id` | `int64` | | ☐ | Store id | | `suffix` | `varchar2` | | ☐ | Suffix | | `taxvat` | `varchar2` | | ☐ | Tax Vat | | `updated_at` | `varchar2` | | ☐ | Updated at time | | `website_id` | `int64` | | ☐ | Website id |