get: operationId: GetCustomers summary: List Customers description: >- Retrieve a list of customers. The customers can be filtered by fields such as `id`. The customers can also be sorted or paginated. x-authenticated: true parameters: - name: fields in: query description: >- Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. NOTE: This route doesn't allow expanding custom relations. required: false schema: type: string title: fields description: >- Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. NOTE: This route doesn't allow expanding custom relations. externalDocs: url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. required: false schema: type: number title: offset description: The number of items to skip when retrieving a list. externalDocs: url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. required: false schema: type: number title: limit description: Limit the number of items returned in the list. externalDocs: url: '#pagination' - name: order in: query description: >- The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. required: false schema: type: string title: order description: >- The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - name: groups in: query required: false schema: oneOf: - type: string title: groups description: >- Filter by a customer group's ID to retrieve customers that belong to it. - $ref: ../components/schemas/CustomerGroupInCustomerFilters.yaml - type: array description: >- Filter by customer group IDs to retrieve customers that belong to them. items: type: string title: groups description: The customer group's ID. - name: q in: query description: Search term to filter the customer's searchable properties by. required: false schema: type: string title: q description: Search term to filter the customer's searchable properties by. - name: id in: query required: false schema: oneOf: - type: string title: id description: Filter by a customer's ID. - type: array description: Filter by customer IDs. items: type: string title: id description: A customer's ID. - type: object description: Filters to apply on the customer ID. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. $ne: oneOf: - type: string title: $ne description: Filter by values not equal to this parameter. - type: array description: Filter by values not in this array. items: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: oneOf: - type: string title: $in description: Filter by matching value. - type: array description: Filter by values in this array. items: type: string title: $in description: Filter matching values. $nin: type: array description: Filter by values not in this array. items: oneOf: - type: string title: $nin description: Filter by values not matching this parameter. - type: array description: Filter by values not in this array. items: type: string title: $nin description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. $ne: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in description: Filter by values in this array. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin description: Filter by values not in this array. $not: oneOf: - type: string title: $not description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: Filter by values not in this array. items: type: string title: $not description: Filter by values not matching this parameter. $gt: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: >- Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: >- Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: >- Filter arrays that have overlapping values with this parameter. $contains: type: array description: >- Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: >- Filter arrays that contain some of the values of this parameter. $contained: type: array description: >- Filter arrays that contain all values of this parameter. items: type: string title: $contained description: >- Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists description: >- Filter by whether a value for this parameter exists (not `null`). - type: array description: Filter by values not in this array. items: type: string title: $not description: Filter by values not matching this parameter. - type: array description: >- Filter by values not matching the conditions in this parameter. items: oneOf: - type: string title: $not description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. $ne: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in description: Filter by exact matches. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not description: >- Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: Filter by values not in this array. items: type: string title: $not description: >- Filter by values not matching this parameter. $gt: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: >- Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: >- Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: >- Filter arrays that have overlapping values with this parameter. $contains: type: array description: >- Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: >- Filter arrays that contain some of the values of this parameter. $contained: type: array description: >- Filter arrays that contain all values of this parameter. items: type: string title: $contained description: >- Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists description: >- Filter by whether a value for this parameter exists (not `null`). $gt: oneOf: - type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values greater than items in this array. Useful for numbers and dates only. items: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: oneOf: - type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values greater than or equal to items in this array. Useful for numbers and dates only. items: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: oneOf: - type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values less than items in this array. Useful for numbers and dates only. items: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: oneOf: - type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values less than or equal to items in this array. Useful for numbers and dates only. items: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: >- Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: >- Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: >- Filter arrays that have overlapping values with this parameter. $contains: type: array description: >- Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: >- Filter arrays that contain some of the values of this parameter. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained description: Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists description: >- Filter by whether a value for this parameter exists (not `null`). - name: email in: query required: false schema: oneOf: - type: string title: email description: Filter by a customer email. format: email - type: array description: Filter by customer emails. items: type: string title: email description: A customer's email. format: email - type: object description: Filter by conditions on the customer email. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. $ne: oneOf: - type: string title: $ne description: Filter by values not equal to this parameter. - type: array description: Filter by values not in this array. items: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: oneOf: - type: string title: $in description: Filter by matching value. - type: array description: Filter by values in this array. items: type: string title: $in description: Filter matching values. $nin: type: array description: Filter by values not in this array. items: oneOf: - type: string title: $nin description: Filter by values not matching this parameter. - type: array description: Filter by values not in this array. items: type: string title: $nin description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. $ne: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in description: Filter by values in this array. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin description: Filter by values not in this array. $not: oneOf: - type: string title: $not description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: Filter by values not in this array. items: type: string title: $not description: Filter by values not matching this parameter. $gt: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: >- Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: >- Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: >- Filter arrays that have overlapping values with this parameter. $contains: type: array description: >- Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: >- Filter arrays that contain some of the values of this parameter. $contained: type: array description: >- Filter arrays that contain all values of this parameter. items: type: string title: $contained description: >- Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists description: >- Filter by whether a value for this parameter exists (not `null`). - type: array description: Filter by values not in this array. items: type: string title: $not description: Filter by values not matching this parameter. - type: array description: >- Filter by values not matching the conditions in this parameter. items: oneOf: - type: string title: $not description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. $ne: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in description: Filter by exact matches. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not description: >- Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: Filter by values not in this array. items: type: string title: $not description: >- Filter by values not matching this parameter. $gt: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: >- Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: >- Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: >- Filter arrays that have overlapping values with this parameter. $contains: type: array description: >- Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: >- Filter arrays that contain some of the values of this parameter. $contained: type: array description: >- Filter arrays that contain all values of this parameter. items: type: string title: $contained description: >- Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists description: >- Filter by whether a value for this parameter exists (not `null`). $gt: oneOf: - type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values greater than items in this array. Useful for numbers and dates only. items: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: oneOf: - type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values greater than or equal to items in this array. Useful for numbers and dates only. items: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: oneOf: - type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values less than items in this array. Useful for numbers and dates only. items: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: oneOf: - type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values less than or equal to items in this array. Useful for numbers and dates only. items: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: >- Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: >- Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: >- Filter arrays that have overlapping values with this parameter. $contains: type: array description: >- Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: >- Filter arrays that contain some of the values of this parameter. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained description: Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists description: >- Filter by whether a value for this parameter exists (not `null`). - name: company_name in: query required: false schema: oneOf: - type: string title: company_name description: Filter by a customer's company name. - type: array description: Filter by customer company names. items: type: string title: company_name description: The customer's company name. - type: object description: Filter by conditions on the customer's company name. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. $ne: oneOf: - type: string title: $ne description: Filter by values not equal to this parameter. - type: array description: Filter by values not in this array. items: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: oneOf: - type: string title: $in description: Filter by matching value. - type: array description: Filter by values in this array. items: type: string title: $in description: Filter matching values. $nin: type: array description: Filter by values not in this array. items: oneOf: - type: string title: $nin description: Filter by values not matching this parameter. - type: array description: Filter by values not in this array. items: type: string title: $nin description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. $ne: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in description: Filter by values in this array. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin description: Filter by values not in this array. $not: oneOf: - type: string title: $not description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: Filter by values not in this array. items: type: string title: $not description: Filter by values not matching this parameter. $gt: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: >- Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: >- Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: >- Filter arrays that have overlapping values with this parameter. $contains: type: array description: >- Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: >- Filter arrays that contain some of the values of this parameter. $contained: type: array description: >- Filter arrays that contain all values of this parameter. items: type: string title: $contained description: >- Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists description: >- Filter by whether a value for this parameter exists (not `null`). - type: array description: Filter by values not in this array. items: type: string title: $not description: Filter by values not matching this parameter. - type: array description: >- Filter by values not matching the conditions in this parameter. items: oneOf: - type: string title: $not description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. $ne: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in description: Filter by exact matches. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not description: >- Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: Filter by values not in this array. items: type: string title: $not description: >- Filter by values not matching this parameter. $gt: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: >- Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: >- Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: >- Filter arrays that have overlapping values with this parameter. $contains: type: array description: >- Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: >- Filter arrays that contain some of the values of this parameter. $contained: type: array description: >- Filter arrays that contain all values of this parameter. items: type: string title: $contained description: >- Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists description: >- Filter by whether a value for this parameter exists (not `null`). $gt: oneOf: - type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values greater than items in this array. Useful for numbers and dates only. items: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: oneOf: - type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values greater than or equal to items in this array. Useful for numbers and dates only. items: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: oneOf: - type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values less than items in this array. Useful for numbers and dates only. items: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: oneOf: - type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values less than or equal to items in this array. Useful for numbers and dates only. items: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: >- Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: >- Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: >- Filter arrays that have overlapping values with this parameter. $contains: type: array description: >- Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: >- Filter arrays that contain some of the values of this parameter. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained description: Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists description: >- Filter by whether a value for this parameter exists (not `null`). - name: first_name in: query required: false schema: oneOf: - type: string title: first_name description: Filter by a customer's first name. - type: array description: Filter by customer first names. items: type: string title: first_name description: A customer's first name. - type: object description: Filter by conditions on the first name. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. $ne: oneOf: - type: string title: $ne description: Filter by values not equal to this parameter. - type: array description: Filter by values not in this array. items: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: oneOf: - type: string title: $in description: Filter by matching value. - type: array description: Filter by values in this array. items: type: string title: $in description: Filter matching values. $nin: type: array description: Filter by values not in this array. items: oneOf: - type: string title: $nin description: Filter by values not matching this parameter. - type: array description: Filter by values not in this array. items: type: string title: $nin description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. $ne: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in description: Filter by values in this array. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin description: Filter by values not in this array. $not: oneOf: - type: string title: $not description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: Filter by values not in this array. items: type: string title: $not description: Filter by values not matching this parameter. $gt: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: >- Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: >- Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: >- Filter arrays that have overlapping values with this parameter. $contains: type: array description: >- Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: >- Filter arrays that contain some of the values of this parameter. $contained: type: array description: >- Filter arrays that contain all values of this parameter. items: type: string title: $contained description: >- Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists description: >- Filter by whether a value for this parameter exists (not `null`). - type: array description: Filter by values not in this array. items: type: string title: $not description: Filter by values not matching this parameter. - type: array description: >- Filter by values not matching the conditions in this parameter. items: oneOf: - type: string title: $not description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. $ne: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in description: Filter by exact matches. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not description: >- Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: Filter by values not in this array. items: type: string title: $not description: >- Filter by values not matching this parameter. $gt: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: >- Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: >- Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: >- Filter arrays that have overlapping values with this parameter. $contains: type: array description: >- Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: >- Filter arrays that contain some of the values of this parameter. $contained: type: array description: >- Filter arrays that contain all values of this parameter. items: type: string title: $contained description: >- Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists description: >- Filter by whether a value for this parameter exists (not `null`). $gt: oneOf: - type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values greater than items in this array. Useful for numbers and dates only. items: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: oneOf: - type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values greater than or equal to items in this array. Useful for numbers and dates only. items: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: oneOf: - type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values less than items in this array. Useful for numbers and dates only. items: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: oneOf: - type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values less than or equal to items in this array. Useful for numbers and dates only. items: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: >- Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: >- Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: >- Filter arrays that have overlapping values with this parameter. $contains: type: array description: >- Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: >- Filter arrays that contain some of the values of this parameter. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained description: Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists description: >- Filter by whether a value for this parameter exists (not `null`). - name: last_name in: query required: false schema: oneOf: - type: string title: last_name description: Filter by a customer's last name. - type: array description: Filter by customer last names. items: type: string title: last_name description: A customer's last name. - type: object description: Filter by conditions on a customer's last name. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. $ne: oneOf: - type: string title: $ne description: Filter by values not equal to this parameter. - type: array description: Filter by values not in this array. items: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: oneOf: - type: string title: $in description: Filter by matching value. - type: array description: Filter by values in this array. items: type: string title: $in description: Filter matching values. $nin: type: array description: Filter by values not in this array. items: oneOf: - type: string title: $nin description: Filter by values not matching this parameter. - type: array description: Filter by values not in this array. items: type: string title: $nin description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. $ne: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in description: Filter by values in this array. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin description: Filter by values not in this array. $not: oneOf: - type: string title: $not description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: Filter by values not in this array. items: type: string title: $not description: Filter by values not matching this parameter. $gt: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: >- Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: >- Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: >- Filter arrays that have overlapping values with this parameter. $contains: type: array description: >- Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: >- Filter arrays that contain some of the values of this parameter. $contained: type: array description: >- Filter arrays that contain all values of this parameter. items: type: string title: $contained description: >- Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists description: >- Filter by whether a value for this parameter exists (not `null`). - type: array description: Filter by values not in this array. items: type: string title: $not description: Filter by values not matching this parameter. - type: array description: >- Filter by values not matching the conditions in this parameter. items: oneOf: - type: string title: $not description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. $ne: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in description: Filter by exact matches. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not description: >- Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: Filter by values not in this array. items: type: string title: $not description: >- Filter by values not matching this parameter. $gt: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: >- Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: >- Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: >- Filter arrays that have overlapping values with this parameter. $contains: type: array description: >- Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: >- Filter arrays that contain some of the values of this parameter. $contained: type: array description: >- Filter arrays that contain all values of this parameter. items: type: string title: $contained description: >- Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists description: >- Filter by whether a value for this parameter exists (not `null`). $gt: oneOf: - type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values greater than items in this array. Useful for numbers and dates only. items: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: oneOf: - type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values greater than or equal to items in this array. Useful for numbers and dates only. items: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: oneOf: - type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values less than items in this array. Useful for numbers and dates only. items: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: oneOf: - type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values less than or equal to items in this array. Useful for numbers and dates only. items: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: >- Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: >- Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: >- Filter arrays that have overlapping values with this parameter. $contains: type: array description: >- Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: >- Filter arrays that contain some of the values of this parameter. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained description: Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists description: >- Filter by whether a value for this parameter exists (not `null`). - name: created_by in: query required: false schema: oneOf: - type: string title: created_by description: Filter by a user ID to retrieve the customers they created. - type: array description: Filter by user IDs to retrieve customers they created. items: type: string title: created_by description: A user's ID. - type: object description: Filter by conditions on the user ID that created the customer. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. $ne: oneOf: - type: string title: $ne description: Filter by values not equal to this parameter. - type: array description: Filter by values not in this array. items: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: oneOf: - type: string title: $in description: Filter by matching value. - type: array description: Filter by values in this array. items: type: string title: $in description: Filter matching values. $nin: type: array description: Filter by values not in this array. items: oneOf: - type: string title: $nin description: Filter by values not matching this parameter. - type: array description: Filter by values not in this array. items: type: string title: $nin description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. $ne: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in description: Filter by values in this array. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin description: Filter by values not in this array. $not: oneOf: - type: string title: $not description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: Filter by values not in this array. items: type: string title: $not description: Filter by values not matching this parameter. $gt: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: >- Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: >- Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: >- Filter arrays that have overlapping values with this parameter. $contains: type: array description: >- Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: >- Filter arrays that contain some of the values of this parameter. $contained: type: array description: >- Filter arrays that contain all values of this parameter. items: type: string title: $contained description: >- Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists description: >- Filter by whether a value for this parameter exists (not `null`). - type: array description: Filter by values not in this array. items: type: string title: $not description: Filter by values not matching this parameter. - type: array description: >- Filter by values not matching the conditions in this parameter. items: oneOf: - type: string title: $not description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. $ne: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in description: Filter by exact matches. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not description: >- Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: Filter by values not in this array. items: type: string title: $not description: >- Filter by values not matching this parameter. $gt: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: >- Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: >- Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: >- Filter arrays that have overlapping values with this parameter. $contains: type: array description: >- Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: >- Filter arrays that contain some of the values of this parameter. $contained: type: array description: >- Filter arrays that contain all values of this parameter. items: type: string title: $contained description: >- Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists description: >- Filter by whether a value for this parameter exists (not `null`). $gt: oneOf: - type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values greater than items in this array. Useful for numbers and dates only. items: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: oneOf: - type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values greater than or equal to items in this array. Useful for numbers and dates only. items: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: oneOf: - type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values less than items in this array. Useful for numbers and dates only. items: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: oneOf: - type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. - type: array description: >- Filter by values less than or equal to items in this array. Useful for numbers and dates only. items: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: >- Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: >- Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: >- Filter arrays that have overlapping values with this parameter. $contains: type: array description: >- Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: >- Filter arrays that contain some of the values of this parameter. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained description: Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists description: >- Filter by whether a value for this parameter exists (not `null`). - name: created_at in: query description: Filter by the customer's creation date. required: false schema: type: object description: Filter by the customer's creation date. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by multiple exact matches. items: type: string title: $eq description: An exact match. $ne: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin description: The value not to match. $not: oneOf: - type: string title: $not description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by multiple exact matches. items: type: string title: $eq description: The value to match. $ne: type: string title: $ne description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin description: The value to not match $not: oneOf: - type: string title: $not description: Filter by values not matching this parameter - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: >- Filter by values not matching the values of this parameter. items: type: string title: $not description: The values to not match. $gt: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: >- Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: >- Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: The value to match. $contains: type: array description: >- Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained description: The values to match. $exists: type: boolean title: $exists description: >- Filter by whether a value for this parameter exists (not `null`). - type: array description: Filter by values not matching those in this parameter. items: type: string title: $not description: The values to not match. $gt: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: The values to match. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained description: The values to match. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query description: Filter by a customer's update date. required: false schema: type: object description: Filter by a customer's update date. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by multiple exact matches. items: type: string title: $eq description: An exact match. $ne: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin description: The value not to match. $not: oneOf: - type: string title: $not description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by multiple exact matches. items: type: string title: $eq description: The value to match. $ne: type: string title: $ne description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin description: The value to not match $not: oneOf: - type: string title: $not description: Filter by values not matching this parameter - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: >- Filter by values not matching the values of this parameter. items: type: string title: $not description: The values to not match. $gt: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: >- Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: >- Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: The value to match. $contains: type: array description: >- Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained description: The values to match. $exists: type: boolean title: $exists description: >- Filter by whether a value for this parameter exists (not `null`). - type: array description: Filter by values not matching those in this parameter. items: type: string title: $not description: The values to not match. $gt: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: The values to match. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained description: The values to match. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query description: Filter a customer by their deletion date. required: false schema: type: object description: Filter a customer by their deletion date. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by multiple exact matches. items: type: string title: $eq description: An exact match. $ne: type: string title: $ne description: Filter by values not equal to this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin description: The value not to match. $not: oneOf: - type: string title: $not description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this parameter. properties: $and: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and $or: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or $eq: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array description: Filter by multiple exact matches. items: type: string title: $eq description: The value to match. $ne: type: string title: $ne description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin description: The value to not match $not: oneOf: - type: string title: $not description: Filter by values not matching this parameter - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: >- Filter by values not matching the values of this parameter. items: type: string title: $not description: The values to not match. $gt: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: >- Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: >- Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: The value to match. $contains: type: array description: >- Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained description: The values to match. $exists: type: boolean title: $exists description: >- Filter by whether a value for this parameter exists (not `null`). - type: array description: Filter by values not matching those in this parameter. items: type: string title: $not description: The values to not match. $gt: type: string title: $gt description: >- Filter by values greater than this parameter. Useful for numbers and dates only. $gte: type: string title: $gte description: >- Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: type: string title: $lt description: >- Filter by values less than this parameter. Useful for numbers and dates only. $lte: type: string title: $lte description: >- Filter by values less than or equal to this parameter. Useful for numbers and dates only. $like: type: string title: $like description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike description: Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext description: Filter to apply on full-text properties. $overlap: type: array description: Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap description: The values to match. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained description: The values to match. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - name: $and in: query description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. required: false schema: type: array description: >- Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: type: object title: $and - name: $or in: query description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. required: false schema: type: array description: >- Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. items: type: object title: $or - name: has_account in: query description: Filter by whether the customer is registered. required: false schema: type: boolean title: has_account description: Filter by whether the customer is registered. security: - api_token: [] - cookie_auth: [] - jwt_token: [] x-codeSamples: - lang: Shell label: cURL source: $ref: ../code_samples/Shell/admin_customers/get.sh tags: - Customers responses: '200': description: OK content: application/json: schema: allOf: - type: object description: The paginated list of customers. required: - limit - offset - count properties: limit: type: number title: limit description: The maximum number of items returned in the list. offset: type: number title: offset description: >- The number of items skipped before retrieving the returned items. count: type: number title: count description: The total number of items. - type: object description: The paginated list of customers. required: - customers properties: customers: $ref: ../components/schemas/AdminCustomer.yaml '400': $ref: ../components/responses/400_error.yaml '401': $ref: ../components/responses/unauthorized.yaml '404': $ref: ../components/responses/not_found_error.yaml '409': $ref: ../components/responses/invalid_state_error.yaml '422': $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml post: operationId: PostCustomers summary: Create Customer description: Create a customer. x-authenticated: true parameters: - name: fields in: query description: >- Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. NOTE: This route doesn't allow expanding custom relations. required: false schema: type: string title: fields description: >- Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. NOTE: This route doesn't allow expanding custom relations. externalDocs: url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] - jwt_token: [] requestBody: content: application/json: schema: allOf: - type: object description: The customer's details. required: - email - company_name - first_name - last_name - phone - metadata properties: email: type: string title: email description: The customer's email. format: email company_name: type: string title: company_name description: The customer's company name. first_name: type: string title: first_name description: The customer's first name. last_name: type: string title: last_name description: The customer's last name. phone: type: string title: phone description: The customer's phone. metadata: type: object description: The customer's metadata. - type: object description: The customer's details. properties: additional_data: type: object description: >- Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. description: The customer's details. x-codeSamples: - lang: Shell label: cURL source: $ref: ../code_samples/Shell/admin_customers/post.sh tags: - Customers responses: '200': description: OK content: application/json: schema: $ref: ../components/schemas/AdminCustomerResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': $ref: ../components/responses/unauthorized.yaml '404': $ref: ../components/responses/not_found_error.yaml '409': $ref: ../components/responses/invalid_state_error.yaml '422': $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml x-workflow: createCustomersWorkflow