crm/engagements

List Engagements

Changed on
get/crm/engagements

Request

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

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

  • ef360d76c658Revision changes
    • breaking

      for the query request parameter limit, default value 50 was removed

  • 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