opportunities list
GET {{baseUrl}}/opportunities
Returns a list of Opportunity objects.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
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. | |
page_size | number | Number of results to return per page. |
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":"urn:uuid:0e3d6e5c-4116-851c-094e-6f2feb922b63","remote_id":"19202938","name":"Needs Integrations","description":"Needs a Unified API for Integrations!","amount":100000,"owner":"0358cbc6-2040-430a-848e-aafacbadf3aa","account":"0958cbc6-6040-430a-848e-aafacbadf4ae","stage":"1968cbc6-6040-430a-848e-aafacbadf4ad","is_closed":true,"is_won":true,"last_activity_at":"2022-02-10T00:00:00Z","close_date":"2022-02-10T00:00:00Z","remote_created_at":"2021-11-10T00:00:00Z"},{"id":"urn:uuid:f4514978-e5f6-dbca-bd47-39002115e74b","remote_id":"19202938","name":"Needs Integrations","description":"Needs a Unified API for Integrations!","amount":100000,"owner":"0358cbc6-2040-430a-848e-aafacbadf3aa","account":"0958cbc6-6040-430a-848e-aafacbadf4ae","stage":"1968cbc6-6040-430a-848e-aafacbadf4ad","is_closed":true,"is_won":true,"last_activity_at":"2022-02-10T00:00:00Z","close_date":"2022-02-10T00:00:00Z","remote_created_at":"2021-11-10T00:00:00Z"}]}