STstreakyc
Tasks

List upcoming tasks

Changed on

Lists tasks across all pipelines and boxes. By default, returns incomplete tasks assigned to the current user before tomorrow in the user's timezone, which includes today's and overdue tasks. Use userKeys, pipelineKey, includeCompleted, direction, limit, and sortOrder to page through other agenda slices.

get/v2/tasks

Request

  • Base URL
    https://api.streak.com/api
  • URL
    https://api.streak.com/api/v2/tasks
  • Auth
    HTTP bearer

Query parameters

directionstring nullable

Agenda direction. Accepted values are desc, past, asc, and future. Defaults to desc.

includeCompletedboolean

Whether completed tasks should be included in the returned agenda.

limitinteger

Maximum number of tasks to return per assigned user.

pipelineKeystring nullable

Key for the pipeline to filter tasks to. Omit to search across all visible pipelines.

sortOrderstring nullable

Opaque 30-digit sort cursor returned as task.sortOrder. Omit to use tomorrow at local midnight as the cursor boundary.

userKeysstring[] nullable

User keys whose assigned tasks should be returned. Omit to return tasks assigned to the current user.

Response

OK

hasNextPageboolean

Whether another page is available. A page can be empty after permission filtering even when this is true.

cursorstring nullable

Continuation cursor for endpoints that use cursor pagination. Pass it as cursor to request the next page. Omitted for page-number pagination and when no continuation cursor remains.

Example response

{
  "results": [
    {
      "creationDate": 1646870400000,
      "lastSavedTimestamp": 1646870400000,
      "lastStatusChangeDate": 1646870400000,
      "dueDate": 1646870400000,
      "actions": [
        {
          "contact": {
            "creationDate": 1646870400000,
            "versionTimestamp": 1646870400000,
            "lastSavedTimestamp": 1646870400000,
            "lastEnrichmentTimestamp": 1646870400000,
            "contactLinks": [
              {
                "creationTimestamp": 1646870400000
              }
            ],
            "orgLinks": [
              {
                "creationTimestamp": 1646870400000
              }
            ]
          }
        }
      ]
    }
  ]
}

Changes