--- title: "Searches Customer Types by parameters" url: "https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/d3750347-3c58-45e9-b3b1-b23a00e713ed/operations/get-customertypes" --- > Full API specification: https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/d3750347-3c58-45e9-b3b1-b23a00e713ed.md # Searches Customer Types by parameters `GET` `/customertypes` Operation ID: `get-customertypes` Searches Customer Types by parameters ## Query parameters - `order_by` (string, optional) - Order by. Available field name values: id (default), active, name, default, modified_on Available direction values: asc, desc. Example: id asc, supplier desc - `filter_by` (string, optional) - Filter by. Available field name values: id, active, name, default, deleted, modified_since In string values: '|' and ',' characters have to be escaped with slash, i.e. '\\,' '\\|' For operators that support multiple values (in, notin): multiple values are delimited using '|' character Available operators: eq - Equal neq - Not equals lt - Less lte - Less or equal gt - Greater gte - Greater or equal in - In notin - Not In contains - Contains isnull - Is Null isnullorempty - Is Null Or Empty isnotnull - Is Not Null startswith - Starts with endswith - Ends with doesnotcontain - Does not contain For non-nullable fields operators isnull and isnotnull are unavailable For dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable For strings operators: lt, lte, gt, gte are unavailable Example: id:eq:303062 - `page_number` (integer, int32, optional) - Format - int32. - `page_size` (integer, int32, optional) - Format - int32. ## Header parameters - `x-api-key` (string, required) - Api subscription key - `Cache-Control` (string, optional) - `Authorization` (string, required) - Bearer token for authorization (e.g., Bearer ) ## Responses - `200` - Paging Response with Customer Types data - `400` - Bad request - `401` - Unauthorized - `403` - Forbidden ## OpenAPI definition ```yaml openapi: 3.0.1 info: title: Retail Express API version: V2 servers: - url: https://api.retailexpress.com.au/v2 paths: /customertypes: get: tags: - customertypes summary: Searches Customer Types by parameters description: Searches Customer Types by parameters operationId: get-customertypes parameters: - name: order_by in: query description: "Order by. \r \r Available field name values: id (default), active, name, default, modified_on\r \r Available direction values: asc, desc. \r \r Example: id asc, supplier desc" schema: type: string description: "Order by. \r \r Available field name values: id (default), active, name, default, modified_on\r \r Available direction values: asc, desc. \r \r Example: id asc, supplier desc" nullable: true - name: filter_by in: query description: "Filter by. \r \r Available field name values: id, active, name, default, deleted, modified_since\r \ \r In string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r \ \r For operators that support multiple values (in, notin): multiple values are delimited using '|' character\r \r Available operators:\r \r eq - Equal\r \r neq - Not equals\r \r lt - Less\r \r lte - Less or equal\r \r gt - Greater\r \r gte - Greater or equal\r \r in - In\r \r notin - Not In\r \ \r contains - Contains\r \r isnull - Is Null\r \ \r isnullorempty - Is Null Or Empty\r \r isnotnull - Is Not Null\r \r startswith - Starts with\r \r endswith - Ends with\r \r doesnotcontain - Does not contain\r \ \r For non-nullable fields operators isnull and isnotnull are unavailable\r \r For dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r \ \r For strings operators: lt, lte, gt, gte are unavailable\r \ \r Example: id:eq:303062" schema: type: string description: "Filter by. \r \r Available field name values: id, active, name, default, deleted, modified_since\r \ \r In string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r \ \r For operators that support multiple values (in, notin): multiple values are delimited using '|' character\r \r Available operators:\r \r eq - Equal\r \r neq - Not equals\r \r lt - Less\r \r lte - Less or equal\r \r gt - Greater\r \r gte - Greater or equal\r \r in - In\r \r notin - Not In\r \ \r contains - Contains\r \r isnull - Is Null\r \ \r isnullorempty - Is Null Or Empty\r \r isnotnull - Is Not Null\r \r startswith - Starts with\r \r endswith - Ends with\r \r doesnotcontain - Does not contain\r \ \r For non-nullable fields operators isnull and isnotnull are unavailable\r \r For dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r \ \r For strings operators: lt, lte, gt, gte are unavailable\r \ \r Example: id:eq:303062" nullable: true - name: page_number in: query description: Format - int32. schema: maximum: 100000 minimum: 1 type: integer format: int32 - name: page_size in: query description: Format - int32. schema: maximum: 2147483647 minimum: 1 type: integer format: int32 - name: x-api-key in: header description: Api subscription key required: true schema: type: string - name: Cache-Control in: header required: false schema: type: string default: no-cache - name: Authorization in: header required: true description: Bearer token for authorization (e.g., Bearer ) schema: type: string responses: "200": description: Paging Response with Customer Types data content: application/json: schema: $ref: "#/components/schemas/V2.CustomerType.PagingResponse" example: data: - id: 0 name: string active: true default: true deleted: true modified_on: string page_number: 0 page_size: 0 total_records: 0 "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ProblemDetails" example: type: string title: string status: 0 detail: string instance: string "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ProblemDetails" example: type: string title: string status: 0 detail: string instance: string "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ProblemDetails" example: type: string title: string status: 0 detail: string instance: string security: [] components: schemas: V2.CustomerType.PagingResponse: title: "" type: object properties: data: type: array items: $ref: "#/components/schemas/V2.CustomerType" nullable: true page_number: type: integer format: int32 page_size: type: integer format: int32 total_records: type: integer format: int32 additionalProperties: false ProblemDetails: title: "" type: object properties: type: type: string nullable: true title: type: string nullable: true status: type: integer format: int32 nullable: true detail: type: string nullable: true instance: type: string nullable: true additionalProperties: {} V2.CustomerType: title: "" type: object properties: id: type: integer description: Customer type identifier format: int32 name: maxLength: 60 minLength: 0 type: string description: Customer type name nullable: true active: type: boolean description: Customer type active nullable: true default: type: boolean description: Customer type default nullable: true deleted: type: boolean description: Customer type deleted nullable: true modified_on: type: string description: Customer type last modified format: date-time additionalProperties: false description: Customer type model ```