Companies API
Companies represent organizations in your Pathbound CRM, identified by their domain.
Create a Company
Section titled “Create a Company”POST /v1/companiesRequest Body
Section titled “Request Body”| Field | Type | Required | Description |
|---|---|---|---|
domain | string | yes | Company domain (must be unique). |
properties | object | no | Arbitrary key-value properties. |
Response — 201 Created
Section titled “Response — 201 Created”{ "status": "success", "company": { /* company object */ }}Returns 409 Conflict if a company with the same domain already exists.
List Companies
Section titled “List Companies”GET /v1/companiesQuery Parameters
Section titled “Query Parameters”| Parameter | Type | Default | Description |
|---|---|---|---|
page | number | 1 | Page number. |
limit | number | 20 | Results per page (1–100). |
search | string | — | Free-text search across company fields. |
sort_by | string | — | Field to sort by. |
sort_dir | string | — | Sort direction (asc or desc). |
Response — 200 OK
Section titled “Response — 200 OK”{ "status": "success", "companies": [ /* company objects */ ], "pagination": { "page": 1, "limit": 20, "total_pages": 3, "total_items": 25 }}Get a Company
Section titled “Get a Company”GET /v1/companies/:company_idUpdate a Company
Section titled “Update a Company”PUT /v1/companies/:company_idRequest Body
Section titled “Request Body”| Field | Type | Required | Description |
|---|---|---|---|
properties | object | no | Properties to update. |
Delete a Company
Section titled “Delete a Company”DELETE /v1/companies/:company_idPermanently removes the company.