Vendors

List vendors

Cursor-paginated, scoped to the token's account and role.

get/v1/bill_vendors

Request

  • Base URL: https://api.topkey.io
  • URL: https://api.topkey.io/v1/bill_vendors
  • Auth: HTTP bearer

Query parameters

page[size]integer

Rows per page (max 100).

page[after]string

Opaque cursor from the previous page's meta.next_cursor.

filterobject

filter[field_predicate]=value (Ransack, per-resource allowlist), and the plain-value filters listed. Unknown filters return 400. Filterable fields: accounting_external_id, created_at, external_id, gl_code_id, has_ach_info, id, integration_key, is_1099_vendor, is_active, name, payment_term, payment_type, tax_classification, updated_at, vendor_type.

Comma-separated relationships to sideload into included.

Response

A page of vendors.

Changes

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