KapworkKapwork Partner API
API Reference

Vendors

Vendors endpoint reference

List Vendors

GET /v1/vendors

Returns vendors in your organization.

Query Parameters

ParameterTypeRequiredDescription
debtor_idUUIDNoFilter to vendors with receivables to this debtor

Response

{
  "object": "list",
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "object": "vendor",
      "name": "Acme Corp",
      "created_at": "2026-01-01T00:00:00.000Z",
      "estimated_next_update_at": "2026-01-07T09:30:00.000Z"
    }
  ],
  "total_count": 5
}

Examples

# All vendors
curl "https://api.kapwork.com/v1/vendors" \
  -H "Authorization: Bearer $KAPWORK_API_KEY"

# Vendors for a specific debtor
curl "https://api.kapwork.com/v1/vendors?debtor_id=550e8400-e29b-41d4-a716-446655440002" \
  -H "Authorization: Bearer $KAPWORK_API_KEY"

Vendor Object

FieldTypeDescription
idstringUnique identifier
objectstring"vendor"
namestringCompany name
created_atstringCreation timestamp (ISO8601)
estimated_next_update_atstringEarliest next update across all integrations (nullable)

estimated_next_update_at Behavior

For a vendor, this value represents the earliest scheduled update across all integrations involving this vendor.

Example: If Acme Corp has integrations with BigBuyer (updates at 9:00) and MegaCorp (updates at 10:00), the vendor's estimated_next_update_at will be 9:00.


Common Queries

List all vendors

GET /v1/vendors

Vendors with receivables verified by a specific debtor

GET /v1/vendors?debtor_id=<debtor_id>

Receivables for a vendor

GET /v1/receivables?vendor_id=<vendor_id>

On this page