Tasks

Tasks represent actions that need to be completed and must be associated with a project. Tasks have an optional due date, can be assigned to a user and can have subtasks.

Get all tasks

Copy link

Returns all tasks. This is a cursor-paginated endpoint. For more information, please refer to our documentation on pagination.

API v1
Request
GET

/v1/tasks

Query parameters

cursor

string

For pagination, the marker (an opaque string value) representing the first item on the next page

limit

integer

For pagination, the limit of entries to be returned. If not provided, up to 500 items will be returned.

assignee_id

integer

If supplied, only tasks that are assigned to this user are returned

project_id

integer

If supplied, only tasks that are assigned to this project are returned

parent_task_id

integer

If null is supplied then only parent tasks are returned. If integer is supplied then only subtasks of a specific task are returned. By default all tasks are returned.

done

number

Whether the task is done or not. 0 = Not done, 1 = Done. If not omitted then returns both done and not done tasks.

Values

0

1

Response
200

OK

Expand all
Copy code
    • true
    • [ ... ]
      • { ... }

      Get details of a task

      Copy link

      Returns the details of a specific task.

      API v1
      Request
      GET

      /v1/tasks/{id}

      Path parameters

      id

      integer

      required

      The ID of the task

      Response
      200

      OK

      Expand all
      Copy code
        • true
        • { ... }
          • null

        Add a task

        Copy link

        Adds a new task.

        API v1
        Request
        POST

        /v1/tasks

        Body parameters

        application/json

        title

        string

        required

        The title of the task

        project_id

        number

        required

        The ID of a project

        description

        string

        The description of the task

        parent_task_id

        number

        The ID of a parent task. Can not be ID of a task which is already a subtask.

        assignee_id

        number

        The ID of the user who will be the assignee of the task

        done

        Whether the task is done or not. 0 = Not done, 1 = Done.

        Values

        0

        1

        due_date

        string

        The due date of the task. Format: YYYY-MM-DD.

        Format

        date

        Response
        201

        Created

        Expand all
        Copy code
          • true
          • { ... }
            • null

          Update a task

          Copy link

          Updates a task.

          API v1
          Request
          PUT

          /v1/tasks/{id}

          Path parameters

          id

          integer

          required

          The ID of the task

          Body parameters

          application/json

          title

          string

          The title of the task

          project_id

          number

          The ID of the project this task is associated with

          description

          string

          The description of the task

          parent_task_id

          number

          The ID of a parent task. Can not be ID of a task which is already a subtask.

          assignee_id

          number

          The ID of the user who will be the assignee of the task

          done

          Whether the task is done or not. 0 = Not done, 1 = Done.

          Values

          0

          1

          due_date

          string

          The due date of the task. Format: YYYY-MM-DD.

          Format

          date

          Response
          200

          OK

          Expand all
          Copy code
            • true
            • { ... }
              • null

            Delete a task

            Copy link

            Marks a task as deleted. If the task has subtasks then those will also be deleted.

            API v1
            Request
            DELETE

            /v1/tasks/{id}

            Path parameters

            id

            integer

            required

            The ID of the task

            Response
            200

            OK

            Expand all
            Copy code
              • true
              • { ... }
                • null

              Subscribe to Pipedrive’s Developer Newsletter