API endpoint reference

Companies

Every companies endpoint in the WorkBOS API: parameters, request and response shape, and curl, Node and Python samples generated from the spec.

GET/companies

List companies

Parameters
NameInTypeRequired
limitqueryintegerNo
offsetqueryintegerNo
Responses
StatusDescription
200OK
401Missing/invalid API key
Example request
curl -X GET "https://dkjdtyzjdkumnpdyezbs.supabase.co/functions/v1/api-v1/companies?limit=20&offset=20" \
  -H "Authorization: Bearer YOUR_API_KEY"
POST/companies

Create company

Request body (required)
FieldType
namestring
Responses
StatusDescription
201OK
401Missing/invalid API key
403Read-only key
Example request
curl -X POST "https://dkjdtyzjdkumnpdyezbs.supabase.co/functions/v1/api-v1/companies" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'
GET/companies/{id}

Get a company by id

Parameters
NameInTypeRequired
idpathstringYes
Responses
StatusDescription
200OK
401Missing/invalid API key
404Not found
Example request
curl -X GET "https://dkjdtyzjdkumnpdyezbs.supabase.co/functions/v1/api-v1/companies/REPLACE_WITH_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"
PATCH/companies/{id}

Update a company

Parameters
NameInTypeRequired
idpathstringYes
Request body (required)
FieldType
namestring
Responses
StatusDescription
200OK
401Missing/invalid API key
403Read-only key
404Not found
Example request
curl -X PATCH "https://dkjdtyzjdkumnpdyezbs.supabase.co/functions/v1/api-v1/companies/REPLACE_WITH_ID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'
DELETE/companies/{id}

Delete a company

Parameters
NameInTypeRequired
idpathstringYes
Responses
StatusDescription
200OK
401Missing/invalid API key
403Read-only key
Example request
curl -X DELETE "https://dkjdtyzjdkumnpdyezbs.supabase.co/functions/v1/api-v1/companies/REPLACE_WITH_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"