Skip to main content
GET
/
v1
/
platform
/
businesses
/
{business_id}
/
customers
List customers
curl --request GET \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/customers/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  },
  "results": [
    {
      "type": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "<string>",
      "reference_number": "<string>",
      "individual_name": "<string>",
      "company_name": "<string>",
      "display_name": "<string>",
      "email": "[email protected]",
      "mobile_phone": "<string>",
      "office_phone": "<string>",
      "address_line1": "<string>",
      "address_line2": "<string>",
      "city": "<string>",
      "state_county": "<string>",
      "postal_code": "<string>",
      "country": "<string>",
      "full_address": "<string>",
      "address_string": "<string>",
      "vat_number": "<string>",
      "tax_exempt": true,
      "status": "<string>",
      "is_active": true,
      "is_archived": true,
      "transaction_tags": [
        "<unknown>"
      ],
      "notes": "<string>",
      "metadata": "<unknown>",
      "payment_terms_days": 123,
      "credit_limit": 123,
      "credit_limit_cents": 123,
      "outstanding_balance": 123,
      "documents": [
        {
          "url": "<string>",
          "expires_in": 123,
          "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "file_name": "<string>",
          "file_size": 123,
          "mime_type": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "archived_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>

Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.

Path Parameters

​
business_id
string<uuid>
required

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

Query Parameters

​
external_id
string

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

​
external_id_contains
string

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

​
include_archived
boolean
default:false

Include archived customers in the response. Defaults to false.

​
name
string

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

​
name_contains
string

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

​
page
integer

Page number (1-indexed, default: 1)

​
page_size
integer

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

Response

​
count
integer
required

Total number of items

Example:

123

​
page_info
object
required
Example:
{
  "total_count": 123,
  "current_page": 1,
  "total_pages": 7,
  "page_size": 20
}
​
results
object[]
required