Sign inStart for free
    1. Task
    2. /Task

    Task

    A Task is a defined, actionable item with references to Records and assigned Workspace Members.

    List Tasks

    List all Tasks. Results are sorted by creation date, from oldest to newest.

    Scopes

    • task:readrequired
    • user_management:readrequired
    • record_permission:readrequired
    • object_configuration:readrequired

    Query params

    limitinteger

    The maximum number of results to return. Defaults to 500. See the full guide to pagination here.

    offsetinteger

    The number of results to skip over before returning. Defaults to 0. See the full guide to pagination here.

    Response

    Status code

    Description

    Request

    GET
    /v2/tasks
    curl https://api.attio.com/v2/tasks?limit=10&offset=5 \
      -H "Authorization: Bearer <token>"

    Response

    200 - Success

    {
      "data": [
        {
          "id": {
            "task_id": "649e34f4-c39a-4f4d-99ef-48a36bef8f04",
            "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
          },
          "assignees": [
            {
              "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
              "referenced_actor_type": "workspace-member"
            }
          ],
          "created_at": "2022-11-21T13:22:49.061281000Z",
          "deadline_at": "2023-03-06",
          "is_completed": false,
          "linked_records": [
            {
              "target_object_id": "people",
              "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
            }
          ],
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "content_plaintext": "Follow up on current software solutions"
        }
      ]
    }

    Create a Task

    Creates a new Task.

    At present, Tasks can only be created from plaintext without Record reference formatting.

    Scopes

    • task:read-writerequired
    • user_management:readrequired
    • record_permission:readrequired
    • object_configuration:readrequired

    Request Body

    dataobject

    REQUIRED

    Response

    Status code

    Description

    Request

    POST
    /v2/tasks
    curl https://api.attio.com/v2/tasks \
      -H "Authorization: Bearer <token>" \
      -H "Content-Type: application/json" \
      -d @- << EOF
        {
          "data": {
            "format": "plaintext",
            "content": "Follow up on current software solutions",
            "assignees": [
              {
                "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
                "referenced_actor_type": "workspace-member"
              }
            ],
            "deadline_at": "2023-03-06",
            "is_completed": false,
            "linked_records": [
              {
                "target_object": "people",
                "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
              }
            ]
          }
        }
    EOF

    Response

    200 - Success

    {
      "data": {
        "id": {
          "task_id": "649e34f4-c39a-4f4d-99ef-48a36bef8f04",
          "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
        },
        "assignees": [
          {
            "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "referenced_actor_type": "workspace-member"
          }
        ],
        "created_at": "2022-11-21T13:22:49.061281000Z",
        "deadline_at": "2023-03-06",
        "is_completed": false,
        "linked_records": [
          {
            "target_object_id": "people",
            "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
          }
        ],
        "created_by_actor": {
          "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
          "type": "workspace-member"
        },
        "content_plaintext": "Follow up on current software solutions"
      }
    }

    Get a Task

    Get a single Task by ID.

    Scopes

    • task:readrequired
    • user_management:readrequired
    • record_permission:readrequired
    • object_configuration:readrequired

    Path params

    task_idstring

    REQUIRED

    The ID of the Task.

    Format: UUID

    Response

    Status code

    Description

    Request

    GET
    /v2/tasks/:task_id
    curl https://api.attio.com/v2/tasks/649e34f4-c39a-4f4d-99ef-48a36bef8f04 \
      -H "Authorization: Bearer <token>"

    Response

    200 - Success

    {}

    Delete a Task

    Delete a Task by ID.

    Scopes

    • task:read-writerequired

    Path params

    task_idstring

    REQUIRED

    The ID of the Task to delete.

    Format: UUID

    Response

    Status code

    Description

    Request

    DELETE
    /v2/tasks/:task_id
    curl https://api.attio.com/v2/tasks/649e34f4-c39a-4f4d-99ef-48a36bef8f04 \
      -H "Authorization: Bearer <token>" \
      -X DELETE

    Response

    200 - Success

    {}
    Terms & conditionsPrivacy policySecurity