Skip to content

Companies API

Companies represent organizations in your Pathbound CRM, identified by their domain.

POST /v1/companies
FieldTypeRequiredDescription
domainstringyesCompany domain (must be unique).
propertiesobjectnoArbitrary key-value properties.
{
"status": "success",
"company": { /* company object */ }
}

Returns 409 Conflict if a company with the same domain already exists.


GET /v1/companies
ParameterTypeDefaultDescription
pagenumber1Page number.
limitnumber20Results per page (1–100).
searchstringFree-text search across company fields.
sort_bystringField to sort by.
sort_dirstringSort direction (asc or desc).
{
"status": "success",
"companies": [ /* company objects */ ],
"pagination": {
"page": 1,
"limit": 20,
"total_pages": 3,
"total_items": 25
}
}

GET /v1/companies/:company_id

PUT /v1/companies/:company_id
FieldTypeRequiredDescription
propertiesobjectnoProperties to update.

DELETE /v1/companies/:company_id

Permanently removes the company.