Search companies
Searches companies of one organization by name (case-insensitive, partial match), sorted by name.
Endpoint
POST/companies with header X-Service-Method: search
Body
| Name | Type | Required | Description |
|---|---|---|---|
organization_id | integer | Yes | Organization to search in. |
searchTerm | string | Yes | Text to find in the company name. Fewer than 2 characters returns an empty page. |
$limit | integer | No | Page size. Default 10, max 50. |
$skip | integer | No | Number of records to skip. |
Request
Response
json
Each item is a full company object; it is shortened here.
Errors
| Status | When |
|---|---|
400 Bad Request | organization_id is missing or not a positive integer. |
403 Forbidden | Your key cannot access organization_id. |
Report an issue with this documentation
Please log in to report issues with our documentation.