| Field | Type | Required | Description | Example |
|---|---|---|---|---|
raw |
?bool | ➖ | Include raw response. Mostly used for debugging purposes | |
consumerId |
?string | ➖ | ID of the consumer which you want to get or push data from | test-consumer |
appId |
?string | ➖ | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX |
serviceId |
?string | ➖ | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
companyId |
?string | ➖ | The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings. | 12345 |
cursor |
?string | ➖ | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
passThrough |
array<string, mixed> | ➖ | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | { "search": "San Francisco" } |
limit |
?int | ➖ | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
filter |
?Components\PurchaseOrdersFilter | ➖ | Apply filters | { "updated_since": "2020-09-30T07:43:32.000Z", "supplier_id": "1234" } |
sort |
?Components\PurchaseOrdersSort | ➖ | Apply sorting | { "by": "updated_at", "direction": "desc" } |