crm/tasks

Retrieve Tasks

Changed on

Retrieve Tasks from any connected Crm software

get/crm/tasks/{id}

Request

  • Base URL
    https://api.panora.dev
  • URL
    https://api.panora.dev/crm/tasks/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required

id of the task 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

subjectstring nullable required

The subject of the task

contentstring nullable required

The content of the task

statusstring nullable required

The status of the task. Authorized values are PENDING, COMPLETED.

due_datestring nullable

The due date of the task

finished_datestring nullable

The finished date of the task

user_idstring nullable

The UUID of the user tied to the task

company_idstring nullable

The UUID of the company tied to the task

deal_idstring nullable

The UUID of the deal tied to the task

field_mappingsobject nullable

The custom field mappings of the task between the remote 3rd party & Panora

idstring nullable

The UUID of the task

remote_idstring nullable

The ID of the task in the context of the Crm 3rd Party

remote_dataobject nullable

The remote data of the task 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

{
  "subject": "Answer customers",
  "content": "Prepare email campaign",
  "status": "PENDING",
  "due_date": "2024-10-01T12:00:00Z",
  "finished_date": "2024-10-01T12:00:00Z",
  "user_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "company_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "deal_id": "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": {
    "key1": "value1",
    "key2": 42,
    "key3": true
  },
  "created_at": "2024-10-01T12:00:00Z",
  "modified_at": "2024-10-01T12:00:00Z"
}

Changes

  • be3dc330edf3Revision changes
    • info

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

    • info

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

  • ca0fa45ebd05Revision changes
    • breaking

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

    • breaking

      the response's property format changed from date-time to no format for status

    • breaking

      the response's property format changed from date-time to no format for status

    • breaking

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

    • warning

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

    • warning

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