Vendors API

Get access to your vendors data through Cloudbox's v1 API.

Retrieving Vendors

Suppliers, with contacts, addresses, and the SKUs they supply.

Use GET /api/v1/vendors to page through every record in your organization, or GET /api/v1/vendors/{id} to fetch a single record with its related data. The id is a UUID, and a 404 means it doesn't exist in your organization.

API Endpoint

GET
/api/v1/vendors
GET
/api/v1/vendors/{id}

Required Headers

Every request must include the following:

Header Key
Description
org-api-key
Your Organization API key. Contact Cloudbox Support For Access: support@cloudboxapp.com.
user-api-key
Your User API Key

Requests missing either header will return 401 Unauthorized

Example Request

bash curl -X GET "https://app.cloudboxapp.com/api/v1/vendors?limit=100" \ -H "org-api-key: YOUR_ORG_API_KEY" \ -H "user-api-key: YOUR_USER_API_KEY" \ -H "Accept: application/json"

Response Schema

Column
Type
Description
id
string (uuid)
Unique ID
vendor_code
string, nullable
name
string, nullable
Sortable
status
string, nullable
Filterable (exact)
category
string, nullable
Filterable (exact)
currency
string, nullable
payment_terms
string, nullable
default_lead_time_days
integer, nullable
tax_rate_id
string (uuid), nullable
References TaxRates
notes
string, nullable
integration_ref
string, nullable
created_at
string (ISO 8601), nullable
Creation timestamp (UTC). Sortable
updated_at
string (ISO 8601), nullable
Last update timestamp (UTC). Sortable
contacts
array of objects
Detail endpoint only. Related records: id, first_name, last_name, email, phone, title, is_primary
locations
array of objects
Detail endpoint only. Related records: id, code, name, address_line_1, address_line_2, city, state, zip, country, attention, is_primary_ship
skus
array of objects
Detail endpoint only. Related records: sku_id, vendor_sku_code, unit_price, lead_time_days, min_order_qty, is_primary

Filters

limitPage size (default 100, max 1000)
offsetNumber of records to skip (default 0)
sortOne of: name, created_at, updated_at
orderasc | desc
searchCase-insensitive partial match on name
statusVendor status
categoryVendor category
updated_sinceOnly records updated at or after this ISO 8601 timestamp
default sortname ascending

Errors

Cloudbox uses standard HTTP status codes to indicate API success or failure:

  • 200–299 – Request succeeded
  • 400 – Bad request (missing parameters, invalid values)
  • 401 – Unauthorized (missing or invalid API keys)
  • 404 – Resource not found
  • 429 – Too many requests (rate limited)