THthredfi
Customers

List customers

List all customers within a business. Only active customers are returned by default, but archived customers can be included via the include_archived flag. Supports standardized pagination.

get/v1/platform/businesses/{business_id}/customers/

Request

  • Base URL
    https://docs.thredfi.com (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP basic
    • or HTTP bearer
    • or HTTP bearer

Path parameters

business_idstring uuid required

Business UUID provided by Thred (unique identifier for the business)

Query parameters

external_idstring

The external ID of the customer to fetch (exact match).

external_id_containsstring

A case-insensitive substring used to filter customers whose external ID contains the specified value.

include_archivedboolean

Include archived customers in the response. Defaults to false.

namestring

The exact name of the customers to fetch (company or individual name).

name_containsstring

A case-insensitive substring used to filter customers whose name contains the specified value.

pageinteger

Page number (1-indexed, default: 1)

page_sizeinteger

Number of items per page (default: 20, max: 100)

Response

countinteger required

Total number of items

Example response

{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.