crm/engagements

Retrieve Engagements

Retrieve Engagements from any connected Crm software

get/crm/engagements/{id}

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

Changed in 6 of the 18 revisions of this API.44512

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

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

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

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

  • ca213ae36b7f211See the full diff
    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ○

      the endpoint scheme security bearer was removed from the API

      api-security-removed

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

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ○

      the endpoint scheme security bearer was added to the API

      api-security-added

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

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

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

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

    • ○

      the endpoint scheme security bearer was removed from the API

      api-security-removed