crm/engagements

Retrieve Engagements

Changed on

Retrieve Engagements from any connected Crm software

get/crm/engagements/{id}

Request

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

Path parameters

idstring required

id of the engagement 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

contentstring nullable

The content of the engagement

directionstring nullable

The direction of the engagement. Authorized values are INBOUND or OUTBOUND

subjectstring nullable

The subject of the engagement

start_atstring date-time nullable

The start time of the engagement

end_timestring date-time nullable

The end time of the engagement

typestring nullable required

The type of the engagement. Authorized values are EMAIL, CALL or MEETING

user_idstring nullable

The UUID of the user tied to the engagement

company_idstring nullable

The UUID of the company tied to the engagement

contactsstring[] nullable

The UUIDs of contacts tied to the engagement object

field_mappingsobject nullable

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

idstring nullable

The UUID of the engagement

remote_idstring nullable

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

remote_dataobject nullable

The remote data of the engagement 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

{
  "content": "Meeting call with CTO",
  "direction": "INBOUND",
  "subject": "Technical features planning",
  "start_at": "2024-10-01T12:00:00Z",
  "end_time": "2024-10-01T22:00:00Z",
  "type": "MEETING",
  "user_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "company_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "contacts": [
    "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

  • be3dc330edf3Revision changes
    • info

      removed the CALL enum value from the response property for the response status

    • info

      removed the EMAIL enum value from the response property for the response status

    • info

      removed the INBOUND enum value from the response property for the response status

    • info

      removed the MEETING enum value from the response property for the response status

    • info

      removed the OUTBOUND enum value from the response property for the response status

  • ca0fa45ebd05Revision changes
    • warning

      added the new CALL enum value to the response property for the response status

    • warning

      added the new EMAIL enum value to the response property for the response status

    • warning

      added the new INBOUND enum value to the response property for the response status

    • warning

      added the new MEETING enum value to the response property for the response status

    • warning

      added the new OUTBOUND enum value to the response property for the response status