POST
/
integrations
/
data
/
crm
/
opportunities
curl --request POST \
  --url https://api.carbon.ai/integrations/data/crm/opportunities \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '{
  "data_source_id": 123,
  "include_remote_data": false,
  "next_cursor": "<string>",
  "page_size": 123,
  "order_dir": "asc",
  "includes": [],
  "filters": {},
  "order_by": "created_at"
}'
{
  "count": 123,
  "next_cursor": "<string>",
  "data": [
    {
      "id": "<string>",
      "owner": {
        "id": "<string>"
      },
      "name": "<string>",
      "description": "<string>",
      "amount": 123,
      "account": {
        "id": "<string>"
      },
      "contact": {
        "id": "<string>"
      },
      "stage": "<string>",
      "status": "WON",
      "close_date": "<string>",
      "last_activity_at": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "is_deleted": true,
      "tasks": [
        {
          "id": "<string>",
          "owner": {
            "id": "<string>"
          },
          "subject": "<string>",
          "status": "<string>",
          "priority": "<string>",
          "description": "<string>",
          "account": {
            "id": "<string>"
          },
          "contact": {
            "id": "<string>"
          },
          "created_at": "<string>",
          "updated_at": "<string>",
          "is_deleted": true,
          "remote_data": {}
        }
      ],
      "events": [
        {
          "id": "<string>",
          "owner": {
            "id": "<string>"
          },
          "subject": "<string>",
          "location": "<string>",
          "is_all_day": true,
          "start_date": "<string>",
          "end_date": "<string>",
          "description": "<string>",
          "account": {
            "id": "<string>"
          },
          "contact": {
            "id": "<string>"
          },
          "created_at": "<string>",
          "updated_at": "<string>",
          "is_deleted": true,
          "remote_data": {}
        }
      ],
      "remote_data": {}
    }
  ]
}

Authorizations

​
authorization
string
header
required

token <token>, corresponds to temporary access tokens.

Body

application/json
​
data_source_id
integer
required
​
include_remote_data
boolean
default:
false
​
next_cursor
string | null
​
page_size
integer | null
​
order_dir
enum<string> | null
default:
asc
Available options:
asc,
desc
​
includes
enum<string>[]
Available options:
Tasks,
Events
​
filters
object
​
order_by
enum<string> | null
Available options:
created_at,
updated_at,
amount,
name,
last_activity_at,
close_date

Response

200
application/json
Successful Response
​
count
integer
required
​
next_cursor
string | null
required
​
data
object[]
required
List Leads