companies list
GET {{baseUrl}}/companies
Returns a list of Company objects.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
created_after | string | If provided, will only return objects created after this datetime. | |
created_before | string | If provided, will only return objects created before this datetime. | |
cursor | string | The pagination cursor value. | |
include_deleted_data | boolean | Whether to include data that was marked as deleted by third party webhooks. | |
include_remote_data | boolean | Whether to include the original data Merge fetched from the third-party to produce these models. | |
modified_after | string | If provided, will only return objects modified after this datetime. | |
modified_before | string | If provided, will only return objects modified before this datetime. | |
page_size | number | Number of results to return per page. | |
remote_id | string | The API provider's ID for the given object. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Accept | string |
RESPONSES
status: OK
{"next":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous":"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results":[{"id":"1b998423-db0a-4037-a4cf-f79c60cb67b3","remote_id":"19202938","legal_name":"Waystar Royco, Inc.","display_name":"Waystar Royco","eins":["12-3456789","12-3451111","11-0011000"],"remote_data":[{"path":"enim ","data":{"dolor_3c6":{},"sunt0":{},"elit_94":{}}},{"path":"eiusmod minim dolore","data":{"eu5_b":{},"cupidatat_0c":{},"in9":{}}}],"remote_was_deleted":true},{"id":"1b998423-db0a-4037-a4cf-f79c60cb67b3","remote_id":"19202938","legal_name":"Waystar Royco, Inc.","display_name":"Waystar Royco","eins":["12-3456789","12-3451111","11-0011000"],"remote_data":[{"path":"ut id Duis veniam","data":{"ad_49":{},"et_6":{}}},{"path":"sunt in dolore","data":{"minim1f":{},"dolorcb":{}}}],"remote_was_deleted":true}]}