v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB

Vendors

Lists all vendors

Returns vendors with pagination and optional status or currency filters. Vendor ids feed bill creation, vendor credits, and payment workflows.

get/vendors

Query parameters

limitinteger

Maximum number of rows to return in the page.

cursorstring

If defined, a cursor to retrieve the next page.

Example:iLQvkEj3sh3UiweC

Pagination cursor to navigate through the full response.

updated.gtstring date-time

Example:2023-01-01T00:00:00Z

Filter vendors updated after this timestamp

Response

Example response

{
  "vendors": [
    {
      "name": "MyVendor",
      "account_code": "11112",
      "address": {
        "line1": "123 Main St",
        "line2": "Apt 4B",
        "city": "Nashville",
        "state": "TN",
        "zip_code": "37201",
        "country": "US"
      },
      "external_references": [
        {
          "type": "xyzSystemId",
          "id": "234",
          "url": "https://xyzsystempage.com/ids/234"
        }
      ],
      "tax_id": "123"
    }
  ],
  "pagination": {
    "next_cursor": "iLQvkEj3sh3UiweC"
  }
}