Sign in
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"
    }
  ]
}

Changes

Changed in 9 of the 49 revisions of this API.9

  • 37e33fd8b0401See the full diff
    • ▲

      for the query request parameter limit, default value 50 was added

      request-parameter-default-value-added

  • 69df76288cd91See the full diff
    • ▲

      for the query request parameter limit, default value 50 was removed

      request-parameter-default-value-removed

  • 47f47d53c24d1See the full diff
    • ▲

      for the query request parameter limit, default value 50 was added

      request-parameter-default-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8c8c3916da221See the full diff
    • ▲

      for the query request parameter limit, default value 50 was removed

      request-parameter-default-value-removed

  • 5ba5c769e2e11See the full diff
    • ▲

      for the query request parameter limit, default value 50 was added

      request-parameter-default-value-added

  • 8f398d57935f1See the full diff
    • ▲

      for the query request parameter limit, default value 50 was removed

      request-parameter-default-value-removed

  • c3d85dda63e01See the full diff
    • ▲

      for the query request parameter limit, default value 50 was added

      request-parameter-default-value-added

  • d33d911413f71See the full diff
    • ▲

      for the query request parameter limit, default value 30 was removed

      request-parameter-default-value-removed

  • 65d2ea9683f61See the full diff
    • ▲

      for the query request parameter limit, default value 30 was added

      request-parameter-default-value-added