List all tasks. Results are sorted by creation date, from oldest to newest.
Required scopes: task:read, object_configuration:read, record_permission:read, user_management:read.
643 matches
49 actions
Attio
49 actions
CRM/Attio
List all tasks. Results are sorted by creation date, from oldest to newest.
Required scopes: task:read, object_configuration:read, record_permission:read, user_management:read.
{
"type": "object",
"properties": {
"assignee": {
"type": [
"string",
"null"
],
"description": "Filter tasks by workspace member assignees. Workspace members can be referenced by either their email address or ID. Pass an empty value or the string `null` to find tasks with no assignee."
},
"is_completed": {
"type": "boolean",
"description": "Filter tasks by whether they have been completed. By default, both completed and non-completed tasks are returned. Specify `true` to only return completed tasks, or `false` to only return non-completed tasks."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to return. Defaults to 500. See the [full guide to pagination here](/rest-api/guides/pagination)."
},
"linked_object": {
"type": "string",
"description": "Pass a value to this parameter to filter results to only those tasks that contain the specified record in the `linked_records` property of the task. This parameter should identify the object that the linked record belongs to. For example, if filtering to tasks that link to a specific person record, this parameter should be `people`. If provided, `linked_record_id` must also be provided."
},
"linked_record_id": {
"type": "string",
"format": "uuid",
"description": "Pass a value to this parameter to filter results to only those tasks that contain the specified record in the `linked_records` property of the task. This parameter should contain the record ID of the linked record. If provided, `linked_object` must also be provided."
},
"offset": {
"type": "integer",
"description": "The number of results to skip over before returning. Defaults to 0. See the [full guide to pagination here](/rest-api/guides/pagination)."
},
"sort": {
"type": "string",
"description": "Optionally sort the results. \"created_at:asc\" returns oldest results first, \"created_at:desc\" returns the newest results first. \"completed_at:asc\" and \"completed_at:desc\" sort by completion time. With \"completed_at:asc\", incomplete tasks (no completion date) appear first, followed by completed tasks oldest-first. With \"completed_at:desc\", completed tasks appear first (newest-first), followed by incomplete tasks. To exclude incomplete tasks, filter by is_completed. If unspecified, defaults to \"created_at:asc\" (oldest results first).",
"enum": [
"created_at:asc",
"created_at:desc",
"completed_at:asc",
"completed_at:desc"
]
}
},
"additionalProperties": false
}{
"type": "object",
"description": "Success",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"content_plaintext",
"deadline_at",
"is_completed",
"completed_at",
"linked_records",
"assignees",
"created_by_actor",
"created_at"
],
"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": [
"workspace_id",
"task_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."
}
}
}
}
}
}
}
}
}