Skip to main content
GET
List vendors

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
required
Pattern: ^[0-9a-f-]+$

Query Parameters

external_id
string

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

external_id_contains
string

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

include_archived
boolean
default:false

Include archived vendors in the response. Defaults to false.

name
string

Exact name match on company or individual name.

name_contains
string

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

page
integer

Page number (default: 1)

page_size
integer

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

Response

count
integer
required

Total number of items

Example:

123

page_info
object
required
Example:
results
object[]
required