Skip to main content
The Suppliers API allows you to manage vendors and suppliers from whom you purchase equipment and supplies.

List Suppliers

curl -X GET "https://your-domain.com/api/v1/suppliers" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
limit
integer
default:"50"
Number of results to return
offset
integer
default:"0"
Offset for pagination
Search string to filter results
sort
string
default:"created_at"
Column to sort by. Allowed values: id, name, address, city, state, country, zip, phone, fax, email, contact, assets_count, licenses_count, accessories_count, consumables_count
order
string
default:"desc"
Sort order: asc or desc
total
integer
Total number of suppliers
rows
array
Array of supplier objects

Get Supplier by ID

curl -X GET "https://your-domain.com/api/v1/suppliers/{supplier_id}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
supplier_id
integer
required
The supplier ID

Create Supplier

curl -X POST "https://your-domain.com/api/v1/suppliers" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Tech Suppliers Inc.",
    "address": "456 Commerce Blvd",
    "city": "San Francisco",
    "state": "CA",
    "country": "US",
    "zip": "94102",
    "phone": "415-555-0100",
    "email": "[email protected]"
  }'
name
string
required
Supplier name
address
string
Street address
address2
string
Address line 2
city
string
City
state
string
State/province
country
string
Country
zip
string
ZIP/postal code
phone
string
Phone number
fax
string
Fax number
email
string
Email address
contact
string
Contact person name
url
string
Website URL
notes
string
Supplier notes
image
string
Base64 encoded image or image file

Update Supplier

curl -X PATCH "https://your-domain.com/api/v1/suppliers/{supplier_id}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Supplier Name",
    "phone": "415-555-0199"
  }'
supplier_id
integer
required
The supplier ID

Delete Supplier

curl -X DELETE "https://your-domain.com/api/v1/suppliers/{supplier_id}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
supplier_id
integer
required
The supplier ID
A supplier cannot be deleted if it has associated assets, licenses, accessories, consumables, or components. You must first reassign or delete those items.

Build docs developers (and LLMs) love