Get a single task by ID.
Required scopes: task:read, object_configuration:read, record_permission:read, user_management:read.
643 matches
49 actions
Attio
49 actions
CRM/Attio
Get a single task by ID.
Required scopes: task:read, object_configuration:read, record_permission:read, user_management:read.
{
"type": "object",
"properties": {
"task_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the task."
}
},
"required": [
"task_id"
],
"additionalProperties": false
}{
"type": "object",
"description": "Success",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"assignees",
"completed_at",
"content_plaintext",
"created_at",
"created_by_actor",
"deadline_at",
"id",
"is_completed",
"linked_records"
],
"properties": {
"assignees": {
"type": "array",
"description": "Workspace members assigned to this task.",
"items": {
"type": "object",
"required": [
"referenced_actor_type",
"referenced_actor_id"
],
"properties": {
"referenced_actor_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the workspace member actor assigned to this task."
},
"referenced_actor_type": {
"type": "string",
"description": "The type of actor. [Read more information on actor types here](/docs/actors).",
"enum": [
"api-token",
"workspace-member",
"system",
"app"
]
}
}
}
},
"completed_at": {
"type": [
"string",
"null"
],
"description": "When the task was completed, or null if it has not been completed."
},
"content_plaintext": {
"type": "string",
"description": "The plaintext representation of the task content. Inline linked records will appear as \"@record name\" and are returned in the `linked_records` property."
},
"created_at": {
"type": "string",
"description": "When the task was created."
},
"created_by_actor": {
"type": "object",
"description": "The actor that created this task.",
"properties": {
"id": {
"type": "string",
"description": "An ID to identify the actor."
},
"type": {
"type": "string",
"description": "The type of actor. [Read more information on actor types here](/docs/actors).",
"enum": [
"api-token",
"workspace-member",
"system",
"app"
]
}
}
},
"deadline_at": {
"type": [
"string",
"null"
],
"description": "The deadline date of the task. Returned as an ISO 8601 timestamp."
},
"id": {
"type": "object",
"required": [
"task_id",
"workspace_id"
],
"properties": {
"task_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the task."
},
"workspace_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the workspace the task belongs to."
}
}
},
"is_completed": {
"type": "boolean",
"description": "Whether the task has been completed."
},
"linked_records": {
"type": "array",
"description": "Records linked to the task. Creating record links within task content text is not possible via the API at present.",
"items": {
"type": "object",
"required": [
"target_object_id",
"target_record_id"
],
"properties": {
"target_object_id": {
"type": "string",
"description": "The ID of the parent object the task refers to. At present, only `people` and `companies` are supported."
},
"target_record_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the parent record the task refers to."
}
}
}
}
}
}
}
}