API endpoint reference

Deals

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

GET/deals

List deals

Parameters

Name	In	Type	Required
limit	query	integer	No
offset	query	integer	No

Responses

Status	Description
200	OK
401	Missing/invalid API key

Example request

curl -X GET "https://dkjdtyzjdkumnpdyezbs.supabase.co/functions/v1/api-v1/deals?limit=20&offset=20" \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/deals

Create deal

Request body (required)

Field	Type
title	string
stage	string
value	number
company_id	string (uuid)
contact_id	string (uuid)
owner_id	string (uuid)

Responses

Status	Description
201	OK
401	Missing/invalid API key
403	Read-only key

Example request

curl -X POST "https://dkjdtyzjdkumnpdyezbs.supabase.co/functions/v1/api-v1/deals" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"string","stage":"string","value":0,"company_id":"00000000-0000-0000-0000-000000000000","contact_id":"00000000-0000-0000-0000-000000000000","owner_id":"00000000-0000-0000-0000-000000000000"}'

GET/deals/{id}

Get a deal by id

Parameters

Name	In	Type	Required
id	path	string	Yes

Responses

Status	Description
200	OK
401	Missing/invalid API key
404	Not found

Example request

curl -X GET "https://dkjdtyzjdkumnpdyezbs.supabase.co/functions/v1/api-v1/deals/REPLACE_WITH_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"

PATCH/deals/{id}

Update a deal

Parameters

Name	In	Type	Required
id	path	string	Yes

Request body (required)

Field	Type
title	string
stage	string
value	number
company_id	string (uuid)
contact_id	string (uuid)
owner_id	string (uuid)

Responses

Status	Description
200	OK
401	Missing/invalid API key
403	Read-only key
404	Not found

Example request

curl -X PATCH "https://dkjdtyzjdkumnpdyezbs.supabase.co/functions/v1/api-v1/deals/REPLACE_WITH_ID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"string","stage":"string","value":0,"company_id":"00000000-0000-0000-0000-000000000000","contact_id":"00000000-0000-0000-0000-000000000000","owner_id":"00000000-0000-0000-0000-000000000000"}'

DELETE/deals/{id}

Delete a deal

Parameters

Name	In	Type	Required
id	path	string	Yes

Responses

Status	Description
200	OK
401	Missing/invalid API key
403	Read-only key

Example request

curl -X DELETE "https://dkjdtyzjdkumnpdyezbs.supabase.co/functions/v1/api-v1/deals/REPLACE_WITH_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"