Enterprise API and Webhooks
Use the vendor API
The first Enterprise API endpoints allow outside systems to list vendors, create a vendor workspace, and read vendor status.
Steps to follow
- 1
Send the API key as an Authorization Bearer token.
- 2
Use GET /api/v1/me to test whether the API key is valid and connected to the right workspace.
- 3
Use GET /api/v1/vendors to list vendor workspaces.
- 4
Use POST /api/v1/vendors with vendor_name and vendor_email to create a draft vendor workspace.
- 5
Use GET /api/v1/vendors/{id} to read one vendor relationship and onboarding status.
- 6
Use GET /api/v1/vendor-applications to read applications submitted through Enterprise vendor intake links.
- 7
Send a unique Idempotency-Key header with each vendor-create request so a retry returns the original result instead of creating another workspace.
- 8
Review API request logs from the API Keys page when a system receives 401, 403, or other errors. Include the returned request_id when contacting support.