offers list
GET {{baseUrl}}/offers
Returns a list of Offer objects.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
application_id | string | If provided, will only return offers for this application. | |
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. | |
creator_id | string | If provided, will only return offers created by this user. | |
cursor | string | The pagination cursor value. | |
expand | string | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | |
include_deleted_data | boolean | Whether to include data that was deleted in the third-party service. | |
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":"dd85625c-6a59-446f-a317-6de64d83bae7","remote_id":"9876","application":"2872ba14-4084-492b-be96-e5eee6fc33ef","creator":"52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633","remote_created_at":"2021-10-15T00:00:00Z","closed_at":"2021-10-16T00:00:00Z","sent_at":"2021-10-15T00:00:00Z","start_date":"2021-11-15T00:00:00Z","status":"DRAFT"},{"id":"dd85625c-6a59-446f-a317-6de64d83bae7","remote_id":"9876","application":"2872ba14-4084-492b-be96-e5eee6fc33ef","creator":"52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633","remote_created_at":"2021-10-15T00:00:00Z","closed_at":"2021-10-16T00:00:00Z","sent_at":"2021-10-15T00:00:00Z","start_date":"2021-11-15T00:00:00Z","status":"SENT-MANUALLY"}]}