v49

latestOpenAPI 3.0.0raw.githubusercontent.com2024-12-22168107389.8 KB
crm/deals

List Deals

get/crm/deals

Query parameters

remote_databoolean

Set to true to include data from the original software.

limitnumber

Set to get the number of records.

cursorstring

Set to get the number of records after this cursor.

Headers

x-connection-tokenstring required

The connection token

Response

prev_cursorstring nullable required
next_cursorstring nullable required

Example response

{
  "data": [
    {
      "name": "Huge Contract with Acme",
      "description": "Contract with Sales Operations Team",
      "amount": 1000,
      "user_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "stage_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "company_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "field_mappings": {
        "fav_dish": "broccoli",
        "fav_color": "red"
      },
      "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "remote_id": "id_1",
      "remote_data": {
        "fav_dish": "broccoli",
        "fav_color": "red"
      },
      "created_at": "2024-10-01T12:00:00Z",
      "modified_at": "2024-10-01T12:00:00Z"
    }
  ]
}