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

NameTypeRequiredDescription
organization_idintegerYesOrganization to search in.
searchTermstringYesText to find in the company name. Fewer than 2 characters returns an empty page.
$limitintegerNoPage size. Default 10, max 50.
$skipintegerNoNumber of records to skip.

Request

Response

json

Each item is a full company object; it is shortened here.

Errors

StatusWhen
400 Bad Requestorganization_id is missing or not a positive integer.
403 ForbiddenYour key cannot access organization_id.

Report an issue with this documentation

Please log in to report issues with our documentation.