TRtrykintsugi
Customers

Get customers

Changed on

The Get Customers API retrieves a paginated list of customers based on specified filters. This API allows searching, filtering by country and state, and sorting the results.

get/v1/customers

Request

  • Base URL
    https://api.trykintsugi.com
  • URL
    https://api.trykintsugi.com/v1/customers
  • Auth
    API key in header X-API-KEY

Query parameters

search_querystring nullable

Search term to filter customers by name or other details

statestring nullable

State or province code to filter customers

source__instring nullable

Filter customers by source (comma-separated)

connection_id__instring nullable

Filter customers by connection ID (comma-separated)

order_bystring nullable

Comma-separated list of fields to sort results by.

pageinteger
sizeinteger

Headers

x-organization-idstring nullable required

The unique identifier for the organization making the request

Response

Successfully retrieved customers

totalinteger required
pageinteger required
sizeinteger required
pagesinteger required

Changes

  • b00368d67377Revision changes
    • warning

      added the new SALEOR enum value to the /// response property for the response status

  • cf78c16e3186Revision changes
    • warning

      added the new FRISBII_BILLING enum value to the /// response property for the response status