Integrate
Quickstart
Basic API usage
Create an API Key
- Log in to Kapwork
- Navigate to Settings → API Keys
- Click Create New Key
- Store the key securely (it is displayed only once)
export KAPWORK_API_KEY="kw_live_abc123..."List Vendors
curl "https://api.kapwork.com/v1/vendors" \
-H "Authorization: Bearer $KAPWORK_API_KEY"The response contains your organization's vendors. Note a vendor_id for subsequent requests.
Fetch Receivables
curl "https://api.kapwork.com/v1/receivables?vendor_id=YOUR_VENDOR_ID" \
-H "Authorization: Bearer $KAPWORK_API_KEY"By default, this returns receivables updated in the last 24 hours. To retrieve all receivables regardless of update time:
curl "https://api.kapwork.com/v1/receivables?vendor_id=YOUR_VENDOR_ID&verified_since=all" \
-H "Authorization: Bearer $KAPWORK_API_KEY"Single Receivable Detail
When you fetch a single receivable by ID, the response includes change history and portal metadata by default:
curl "https://api.kapwork.com/v1/receivables/RECEIVABLE_ID" \
-H "Authorization: Bearer $KAPWORK_API_KEY"What every receivable includes →