API endpoint reference

Contacts

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

GET/contacts

List contacts

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

Create contact

Request body (required)
FieldType
namestring
emailstring (email)
phonestring
company_idstring (uuid)
owner_idstring (uuid)
Responses
StatusDescription
201OK
401Missing/invalid API key
403Read-only key
Example request
curl -X POST "https://dkjdtyzjdkumnpdyezbs.supabase.co/functions/v1/api-v1/contacts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","email":"name@example.com","phone":"string","company_id":"00000000-0000-0000-0000-000000000000","owner_id":"00000000-0000-0000-0000-000000000000"}'
GET/contacts/{id}

Get a contact 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/contacts/REPLACE_WITH_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"
PATCH/contacts/{id}

Update a contact

Parameters
NameInTypeRequired
idpathstringYes
Request body (required)
FieldType
namestring
emailstring (email)
phonestring
company_idstring (uuid)
owner_idstring (uuid)
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/contacts/REPLACE_WITH_ID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","email":"name@example.com","phone":"string","company_id":"00000000-0000-0000-0000-000000000000","owner_id":"00000000-0000-0000-0000-000000000000"}'
DELETE/contacts/{id}

Delete a contact

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/contacts/REPLACE_WITH_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"