Search Companies
Legacy Documentation
You are viewing legacy documentation. These APIs are maintained for partners with existing implementations. New projects should use v2.
View the current GraphQL API Reference → | View the current REST API Reference →
POST/companies/search
> The companies search endpoint is only available on the Propeller cloud version.
Retrieves a list of companies by using the search fields below. Results will be paginated.
| Field | Type |
|---|---|
dateCreated | DateFilter |
dateModified | DateFilter |
debtorIds | array(string) |
offset | integer |
page | integer |
Date filter
A date filter is a special date search object that can search through a range:
{
"from": "2020-12-12T00:00:00",
"to": "2022-12-12T00:00:00"
}
Request
Responses
- 200
- 400
Search Companies - 200
Response Headers
Alt-Svc
Via
alt-svc
content-length
date
return-format
x-request-id
Search Companies - 400
Response Headers
Alt-Svc
Via
alt-svc
content-length
date
return-format
x-request-id