crm/deals

Retrieve Deals

Changed on

Retrieve Deals from any connected Crm software

get/crm/deals/{id}

Request

  • Base URL
    https://api.panora.dev
  • URL
    https://api.panora.dev/crm/deals/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required

id of the deal you want to retrieve.

Query parameters

remote_databoolean

Set to true to include data from the original Crm software.

Headers

x-connection-tokenstring required

The connection token

Response

namestring nullable required

The name of the deal

descriptionstring nullable required

The description of the deal

amountnumber nullable required

The amount of the deal

user_idstring nullable

The UUID of the user who is on the deal

stage_idstring nullable

The UUID of the stage of the deal

company_idstring nullable

The UUID of the company tied to the deal

field_mappingsobject nullable

The custom field mappings of the company between the remote 3rd party & Panora

idstring nullable

The UUID of the deal

remote_idstring nullable

The id of the deal in the context of the Crm 3rd Party

remote_dataobject nullable

The remote data of the deal in the context of the Crm 3rd Party

created_atstring date-time nullable

The created date of the object

modified_atstring date-time nullable

The modified date of the object

Example response

{
  "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

  • ca213ae36b7fRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response's property type changed from object to string, and format from no format to date-time for status

    • breaking

      the response's property type changed from object to string, and format from no format to date-time for status

    • info

      the endpoint scheme security bearer was removed from the API

  • 167edd5346ecRevision changes
    • breaking

      the response's property type changed from string to object, and format from date-time to no format for status

    • breaking

      the response's property type changed from string to object, and format from date-time to no format for status

    • info

      the endpoint scheme security bearer was added to the API

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status