THthredfi
Vendors

List vendors

List all vendors within a business. Active vendors are returned by default; include archived ones with include_archived=true.

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

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 required

Query parameters

external_idstring

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

external_id_containsstring

Filter vendors whose external ID contains the given substring (case-insensitive).

include_archivedboolean

Include archived vendors in the response. Defaults to false.

namestring

Exact name match on company or individual name.

name_containsstring

Substring match on company or individual name (case-insensitive).

pageinteger

Page number (default: 1)

page_sizeinteger

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.