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

List Engagements

get/crm/engagements

Query parameters

remote_databoolean

Set to true to include data from the original software.

limitnumber

Set to get the number of records.

cursorstring

Set to get the number of records after this cursor.

Headers

x-connection-tokenstring required

The connection token

Response

prev_cursorstring nullable required

next_cursorstring nullable required

Example response

{
  "data": [
    {
      "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 10 of the 18 revisions of this API.53512

Nov 18, 2024ef360d76c6581See the full diff
- ▲
  for the query request parameter limit, default value 50 was removed
  request-parameter-default-value-removed
This revision also has 42 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 20, 2024be3dc330edf35See the full diff
- ○
  removed the CALL enum value from the allOf[subschema #2]/data/items/type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the EMAIL enum value from the allOf[subschema #2]/data/items/type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the INBOUND enum value from the allOf[subschema #2]/data/items/direction response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the MEETING enum value from the allOf[subschema #2]/data/items/type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the OUTBOUND enum value from the allOf[subschema #2]/data/items/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 14, 202417251bf7794f1See the full diff
- ▲
  for the query request parameter limit, default value 50 was added
  request-parameter-default-value-added
Aug 9, 20243539cfe8509c1See the full diff
- ▲
  for the query request parameter limit, default value 30 was removed
  request-parameter-default-value-removed
Aug 7, 20243ce49f5aad531See the full diff
- ▲
  for the query request parameter limit, default value 30 was added
  request-parameter-default-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, 2024ca0fa45ebd0515See the full diff
- ▲
  for the query request parameter limit, default value 50 was removed
  request-parameter-default-value-removed
- ●
  added the new CALL enum value to the allOf[subschema #2]/data/items/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new EMAIL enum value to the allOf[subschema #2]/data/items/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new INBOUND enum value to the allOf[subschema #2]/data/items/direction response property for the response status 200
  response-property-enum-value-added
- ●
  added the new MEETING enum value to the allOf[subschema #2]/data/items/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new OUTBOUND enum value to the allOf[subschema #2]/data/items/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, 2024ca213ae36b7f231See the full diff
- ▲
  the response property allOf[PaginatedDto]/next_cursor became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[PaginatedDto]/prev_cursor became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/company_id became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/contacts became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/content became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/created_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/direction became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/end_time became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/field_mappings became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/id became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/modified_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/remote_data became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/remote_id became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/start_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/subject became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/type became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/user_id became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/created_at became optional for the status 200
  response-property-became-optional
- ▲
  the response property allOf[subschema #2]/data/items/field_mappings became optional for the status 200
  response-property-became-optional
- ▲
  the response property allOf[subschema #2]/data/items/modified_at became optional for the status 200
  response-property-became-optional
- ▲
  the response property allOf[subschema #2]/data/items/remote_data became optional for the status 200
  response-property-became-optional
- ▲
  the allOf[subschema #2]/data/items/created_at response's property type/format changed from object/ to string/date-time for status 200
  response-property-type-changed
- ▲
  the allOf[subschema #2]/data/items/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 allOf[subschema #2]/data/items/created_at response's property type/format changed from string/date-time to object/ for status 200
  response-property-type-changed
- ▲
  the allOf[subschema #2]/data/items/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 allOf[subschema #2]/data/items/created_at became required for the status 200
  response-property-became-required
- ○
  the response property allOf[subschema #2]/data/items/field_mappings became required for the status 200
  response-property-became-required
- ○
  the response property allOf[subschema #2]/data/items/modified_at became required for the status 200
  response-property-became-required
- ○
  the response property allOf[subschema #2]/data/items/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, 20249d25bd589fe923See the full diff
- ▲
  the response property allOf[PaginatedDto]/next_cursor became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[PaginatedDto]/prev_cursor became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/company_id became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/contacts became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/content became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/created_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/direction became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/end_time became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/field_mappings became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/id became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/modified_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/remote_data became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/remote_id became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/start_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/subject became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/type became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/user_id became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data/items/created_at became optional for the status 200
  response-property-became-optional
- ▲
  the response property allOf[subschema #2]/data/items/field_mappings became optional for the status 200
  response-property-became-optional
- ▲
  the response property allOf[subschema #2]/data/items/modified_at became optional for the status 200
  response-property-became-optional
- ▲
  the response property allOf[subschema #2]/data/items/remote_data became optional for the status 200
  response-property-became-optional
- ▲
  the allOf[subschema #2]/data/items/created_at response's property type/format changed from object/ to string/date-time for status 200
  response-property-type-changed
- ▲
  the allOf[subschema #2]/data/items/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