Retrieve Engagements
Retrieve Engagements from any connected Crm software
Path parameters
id of the engagement you want to retrieve.
Query parameters
Set to true to include data from the original Crm software.
Headers
The connection token
Response
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
CALLenum value from theresponse property for the response statusresponse-property-enum-value-removed
- ○
removed the
EMAILenum value from theresponse property for the response statusresponse-property-enum-value-removed
- ○
removed the
INBOUNDenum value from theresponse property for the response statusresponse-property-enum-value-removed
- ○
removed the
MEETINGenum value from theresponse property for the response statusresponse-property-enum-value-removed
- ○
removed the
OUTBOUNDenum value from theresponse property for the response statusresponse-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
CALLenum value to theresponse property for the response statusresponse-property-enum-value-added
- ●
added the new
EMAILenum value to theresponse property for the response statusresponse-property-enum-value-added
- ●
added the new
INBOUNDenum value to theresponse property for the response statusresponse-property-enum-value-added
- ●
added the new
MEETINGenum value to theresponse property for the response statusresponse-property-enum-value-added
- ●
added the new
OUTBOUNDenum value to theresponse property for the response statusresponse-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
- ●
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became optional for the statusresponse-property-became-optional
- ▲
the response property
became optional for the statusresponse-property-became-optional
- ▲
the response property
became optional for the statusresponse-property-became-optional
- ▲
the response property
became optional for the statusresponse-property-became-optional
- ▲
the
response's property type changed fromobjecttostring, and format from no format todate-timefor statusresponse-property-type-changed
- ▲
the
response's property type changed fromobjecttostring, and format from no format todate-timefor statusresponse-property-type-changed
- ○
the endpoint scheme security
bearerwas removed from the APIapi-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 fromstringtoobject, and format fromdate-timeto no format for statusresponse-property-type-changed
- ▲
the
response's property type changed fromstringtoobject, and format fromdate-timeto no format for statusresponse-property-type-changed
- ○
the endpoint scheme security
bearerwas added to the APIapi-security-added
- ○
the response property
became required for the statusresponse-property-became-required
- ○
the response property
became required for the statusresponse-property-became-required
- ○
the response property
became required for the statusresponse-property-became-required
- ○
the response property
became required for the statusresponse-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 statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became optional for the statusresponse-property-became-optional
- ▲
the response property
became optional for the statusresponse-property-became-optional
- ▲
the response property
became optional for the statusresponse-property-became-optional
- ▲
the response property
became optional for the statusresponse-property-became-optional
- ▲
the
response's property type changed fromobjecttostring, and format from no format todate-timefor statusresponse-property-type-changed
- ▲
the
response's property type changed fromobjecttostring, and format from no format todate-timefor statusresponse-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
bearerwas removed from the APIapi-security-removed
- ○