accounting/accounts3

accounting/addresses2

accounting/attachments3

accounting/balancesheets2

accounting/cashflowstatements2

accounting/companyinfos2

accounting/contacts3

accounting/creditnotes2

accounting/expenses3

accounting/incomestatements2

accounting/invoices3

accounting/items2

accounting/journalentries3

accounting/payments3

accounting/phonenumbers2

accounting/purchaseorders3

accounting/taxrates2

accounting/trackingcategories2

accounting/transactions2

accounting/vendorcredits2

auth1

connections1

crm/companies3

crm/contacts3

crm/deals3

crm/engagements3

crm/notes3

crm/stages2

crm/tasks3

crm/users2

ecommerce/customers2

ecommerce/fulfillments2

ecommerce/orders3

ecommerce/products3

events1

fieldMappings6

filestorage/files3

filestorage/folders3

filestorage/groups2

filestorage/users2

linkedUsers5

marketingautomation/actions3

marketingautomation/automations3

marketingautomation/campaigns3

marketingautomation/contacts3

marketingautomation/emails2

marketingautomation/events2

marketingautomation/lists3

marketingautomation/messages2

marketingautomation/templates3

marketingautomation/users2

passthrough2

projects2

sync4

ticketing/accounts2

ticketing/attachments3

ticketing/collections2

ticketing/comments3

ticketing/contacts2

ticketing/tags2

ticketing/teams2

ticketing/tickets3

ticketing/users2

webhooks5

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

Sep 20, 2024be3dc330edf35See the full diff
- ○
  removed the CALL enum value from the type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the EMAIL enum value from the type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the INBOUND enum value from the direction response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the MEETING enum value from the type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the OUTBOUND enum value from the direction response property for the response status 200
  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
Aug 5, 2024ca0fa45ebd055See the full diff
- ●
  added the new CALL enum value to the type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new EMAIL enum value to the type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new INBOUND enum value to the direction response property for the response status 200
  response-property-enum-value-added
- ●
  added the new MEETING enum value to the type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new OUTBOUND enum value to the direction response property for the response status 200
  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
Aug 5, 2024ca213ae36b7f211See the full diff
- ▲
  the response property company_id became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property contacts became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property content became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property created_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property direction became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property end_time became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property field_mappings became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property id became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property modified_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property remote_data became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property remote_id became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property start_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property subject became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property type became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property user_id became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property created_at became optional for the status 200
  response-property-became-optional
- ▲
  the response property field_mappings became optional for the status 200
  response-property-became-optional
- ▲
  the response property modified_at became optional for the status 200
  response-property-became-optional
- ▲
  the response property remote_data became optional for the status 200
  response-property-became-optional
- ▲
  the created_at response's property type/format changed from object/ to string/date-time for status 200
  response-property-type-changed
- ▲
  the modified_at response's property type/format changed from object/ to string/date-time for status 200
  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
Aug 5, 2024167edd5346ec25See the full diff
- ▲
  the created_at response's property type/format changed from string/date-time to object/ for status 200
  response-property-type-changed
- ▲
  the modified_at response's property type/format changed from string/date-time to object/ for status 200
  response-property-type-changed
- ○
  the endpoint scheme security bearer was added to the API
  api-security-added
- ○
  the response property created_at became required for the status 200
  response-property-became-required
- ○
  the response property field_mappings became required for the status 200
  response-property-became-required
- ○
  the response property modified_at became required for the status 200
  response-property-became-required
- ○
  the response property remote_data became required for the status 200
  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
Aug 3, 20249d25bd589fe921See the full diff
- ▲
  the response property company_id became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property contacts became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property content became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property created_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property direction became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property end_time became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property field_mappings became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property id became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property modified_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property remote_data became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property remote_id became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property start_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property subject became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property type became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property user_id became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property created_at became optional for the status 200
  response-property-became-optional
- ▲
  the response property field_mappings became optional for the status 200
  response-property-became-optional
- ▲
  the response property modified_at became optional for the status 200
  response-property-became-optional
- ▲
  the response property remote_data became optional for the status 200
  response-property-became-optional
- ▲
  the created_at response's property type/format changed from object/ to string/date-time for status 200
  response-property-type-changed
- ▲
  the modified_at response's property type/format changed from object/ to string/date-time for status 200
  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
Aug 1, 2024414c3e999e0b1See the full diff
- ○
  the endpoint scheme security bearer was removed from the API
  api-security-removed

Full history