Skip to main content
GET
/
v1
/
platform
/
businesses
List businesses
curl --request GET \
  --url https://sandbox.thredfi.com/v1/platform/businesses/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  },
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "customer-123",
      "name": "Acme Coffee Ltd",
      "legal_name": "Acme Coffee Limited",
      "entity_type": "limited",
      "country": "GB",
      "province": "Greater London",
      "eu_nace_industry_code": "56.30",
      "is_active": true,
      "activation_at": "2024-01-15T10:30:00Z",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-03-20T14:22:00Z",
      "vat_number": "GB123456789",
      "company_number": "12345678",
      "tax_id": "1234567890",
      "base_currency": "GBP"
    }
  ]
}

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.

Query Parameters

country
string

Filter by country code (case-insensitive, e.g., GB, DE, FR, MY, SG)

entity_type
string

Filter by entity type (case-insensitive). Valid values depend on business country. Examples: limited, gmbh, bv, sl, etc.

is_archived
boolean

Filter by archived status (true/false)

Filter by legal name (case-insensitive partial match)

page
integer

Page number (default: 1)

page_size
integer

Items per page (default: 20, max: 100)

Search in business name, legal name, external ID, VAT number, and company number

Response

200 - application/json
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