Customers

List customers

Changed on

Lists or searches customers connected to your account. All supported query parameters are optional. If none are provided, the response will include all customers connected to your account. This endpoint supports advanced sorting and filtering options.

get/v1/customers

Request

  • Base URL
    https://sandbox.straddle.com
  • URL
    https://sandbox.straddle.com/v1/customers
  • Auth
    HTTP bearer

Query parameters

page_numberinteger

Page number for paginated results. Starts at 1.

page_sizeinteger

Number of results per page. Maximum: 1000.

sort_by'name' | 'created_at'
sort_order'asc' | 'desc'
created_fromstring date-time

Start date for filtering by created_at date.

created_tostring date-time

End date for filtering by created_at date.

namestring

Filter customers by name (partial match).

external_idstring

Filter by your system's external_id.

emailstring

Filter customers by email address.

statusCustomerStatusV1[]

Filter customers by their current status.

search_textstring

General search term to filter customers.

typesCustomerTypeV1[]

Filter by customer type individual or business.

Headers

Straddle-Account-Idstring uuid

For use by platforms to specify an account_id to set the scope of a request.

Request-Idstring

Optional client generated identifier to trace and debug a request.

Correlation-Idstring

Optional client generated identifier to trace and debug a series of requests.

Response

OK

response_type'object' | 'array' | 'error' | 'none' required

Indicates the structure of the returned content.

  • "object" means the data field contains a single JSON object.
  • "array" means the data field contains an array of objects.
  • "error" means the data field contains an error object with details of the issue.
  • "none" means no data is returned.

Changes

  • de39a60c562eRevision changes
    • breaking

      for the query request parameter page_number, default value was changed from 1 to 1

    • breaking

      for the query request parameter page_size, default value was changed from 100 to 100

  • 4c4191aab91dRevision changes
    • breaking

      removed the enum value Asc from the query request parameter sort_order

    • breaking

      removed the enum value Desc from the query request parameter sort_order

    • breaking

      removed the enum value Business from the property items/ of the query request parameter types

    • breaking

      removed the enum value Individual from the property items/ of the query request parameter types

    • info

      removed the Array enum value from the response property for the response status (media type: text/plain)

    • info

      removed the Array enum value from the response property for the response status (media type: application/json)

    • info

      removed the Array enum value from the response property for the response status (media type: text/json)

    • info

      removed the Array enum value from the response property for the response status (media type: text/plain)

    • info

      removed the Array enum value from the response property for the response status (media type: application/json)

    • info

      removed the Array enum value from the response property for the response status (media type: text/json)

    • info

      removed the Array enum value from the response property for the response status (media type: text/plain)

    • info

      removed the Array enum value from the response property for the response status (media type: application/json)

    • info

      removed the Array enum value from the response property for the response status (media type: text/json)

    • info

      removed the Array enum value from the response property for the response status (media type: text/plain)

    • info

      removed the Array enum value from the response property for the response status (media type: application/json)

    • info

      removed the Array enum value from the response property for the response status (media type: text/json)

    • info

      removed the Array enum value from the response property for the response status (media type: text/plain)

    • info

      removed the Array enum value from the response property for the response status (media type: application/json)

    • info

      removed the Array enum value from the response property for the response status (media type: text/json)

    • info

      removed the Array enum value from the response property for the response status (media type: text/plain)

    • info

      removed the Array enum value from the response property for the response status (media type: application/json)

    • info

      removed the Array enum value from the response property for the response status (media type: text/json)

    • info

      removed the Array enum value from the response property for the response status (media type: text/plain)

    • info

      removed the Array enum value from the response property for the response status (media type: application/json)

    • info

      removed the Array enum value from the response property for the response status (media type: text/json)

    • info

      removed the Asc enum value from the / response property for the response status (media type: text/plain)

    • info

      removed the Asc enum value from the / response property for the response status (media type: application/json)

    • info

      removed the Asc enum value from the / response property for the response status (media type: text/json)

    • info

      removed the Business enum value from the // response property for the response status (media type: text/plain)

    • info

      removed the Business enum value from the // response property for the response status (media type: application/json)

    • info

      removed the Business enum value from the // response property for the response status (media type: text/json)

    • info

      removed the Desc enum value from the / response property for the response status (media type: text/plain)

    • info

      removed the Desc enum value from the / response property for the response status (media type: application/json)

    • info

      removed the Desc enum value from the / response property for the response status (media type: text/json)

    • info

      removed the Error enum value from the response property for the response status (media type: text/plain)

    • info

      removed the Error enum value from the response property for the response status (media type: application/json)

    • info

      removed the Error enum value from the response property for the response status (media type: text/json)

    • info

      removed the Error enum value from the response property for the response status (media type: text/plain)

    • info

      removed the Error enum value from the response property for the response status (media type: application/json)

    • info

      removed the Error enum value from the response property for the response status (media type: text/json)

    • info

      removed the Error enum value from the response property for the response status (media type: text/plain)

    • info

      removed the Error enum value from the response property for the response status (media type: application/json)

    • info

      removed the Error enum value from the response property for the response status (media type: text/json)

    • info

      removed the Error enum value from the response property for the response status (media type: text/plain)

    • info

      removed the Error enum value from the response property for the response status (media type: application/json)

    • info

      removed the Error enum value from the response property for the response status (media type: text/json)

    • info

      removed the Error enum value from the response property for the response status (media type: text/plain)

    • info

      removed the Error enum value from the response property for the response status (media type: application/json)

    • info

      removed the Error enum value from the response property for the response status (media type: text/json)

    • info

      removed the Error enum value from the response property for the response status (media type: text/plain)

    • info

      removed the Error enum value from the response property for the response status (media type: application/json)

    • info

      removed the Error enum value from the response property for the response status (media type: text/json)

    • info

      removed the Error enum value from the response property for the response status (media type: text/plain)

    • info

      removed the Error enum value from the response property for the response status (media type: application/json)

    • info

      removed the Error enum value from the response property for the response status (media type: text/json)

    • info

      removed the Individual enum value from the // response property for the response status (media type: text/plain)

    • info

      removed the Individual enum value from the // response property for the response status (media type: application/json)

    • info

      removed the Individual enum value from the // response property for the response status (media type: text/json)

    • info

      removed the None enum value from the response property for the response status (media type: text/plain)

    • info

      removed the None enum value from the response property for the response status (media type: application/json)

    • info

      removed the None enum value from the response property for the response status (media type: text/json)

    • info

      removed the None enum value from the response property for the response status (media type: text/plain)

    • info

      removed the None enum value from the response property for the response status (media type: application/json)

    • info

      removed the None enum value from the response property for the response status (media type: text/json)

    • info

      removed the None enum value from the response property for the response status (media type: text/plain)

    • info

      removed the None enum value from the response property for the response status (media type: application/json)

    • info

      removed the None enum value from the response property for the response status (media type: text/json)

    • info

      removed the None enum value from the response property for the response status (media type: text/plain)

    • info

      removed the None enum value from the response property for the response status (media type: application/json)

    • info

      removed the None enum value from the response property for the response status (media type: text/json)

    • info

      removed the None enum value from the response property for the response status (media type: text/plain)

    • info

      removed the None enum value from the response property for the response status (media type: application/json)

    • info

      removed the None enum value from the response property for the response status (media type: text/json)

    • info

      removed the None enum value from the response property for the response status (media type: text/plain)

    • info

      removed the None enum value from the response property for the response status (media type: application/json)

    • info

      removed the None enum value from the response property for the response status (media type: text/json)

    • info

      removed the None enum value from the response property for the response status (media type: text/plain)

    • info

      removed the None enum value from the response property for the response status (media type: application/json)

    • info

      removed the None enum value from the response property for the response status (media type: text/json)

    • info

      removed the Object enum value from the response property for the response status (media type: text/plain)

    • info

      removed the Object enum value from the response property for the response status (media type: application/json)

    • info

      removed the Object enum value from the response property for the response status (media type: text/json)

    • info

      removed the Object enum value from the response property for the response status (media type: text/plain)

    • info

      removed the Object enum value from the response property for the response status (media type: application/json)

    • info

      removed the Object enum value from the response property for the response status (media type: text/json)

    • info

      removed the Object enum value from the response property for the response status (media type: text/plain)

    • info

      removed the Object enum value from the response property for the response status (media type: application/json)

    • info

      removed the Object enum value from the response property for the response status (media type: text/json)

    • info

      removed the Object enum value from the response property for the response status (media type: text/plain)

    • info

      removed the Object enum value from the response property for the response status (media type: application/json)

    • info

      removed the Object enum value from the response property for the response status (media type: text/json)

    • info

      removed the Object enum value from the response property for the response status (media type: text/plain)

    • info

      removed the Object enum value from the response property for the response status (media type: application/json)

    • info

      removed the Object enum value from the response property for the response status (media type: text/json)

    • info

      removed the Object enum value from the response property for the response status (media type: text/plain)

    • info

      removed the Object enum value from the response property for the response status (media type: application/json)

    • info

      removed the Object enum value from the response property for the response status (media type: text/json)

    • info

      removed the Object enum value from the response property for the response status (media type: text/plain)

    • info

      removed the Object enum value from the response property for the response status (media type: application/json)

    • info

      removed the Object enum value from the response property for the response status (media type: text/json)