get/tasksRead operation

List tasks

Use this operation to list tasks. It returns only resources visible to the credential and applies the documented filters before producing a bounded, stable page. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.

Required scopes

tasks:read

Request example

curl --request GET \
  --url 'https://api.de.teamgrid.app/v1/tasks?cursor=CURSOR&limit=50&archived=false' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN'

const response = await fetch('https://api.de.teamgrid.app/v1/tasks?cursor=CURSOR&limit=50&archived=false', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
  },
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/tasks?cursor=CURSOR&limit=50&archived=false', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
  },
})

const result: ApiResponse = await response.json()

teamgrid tasks list \
  --output json

Example response 2xx

{
  "data": [
    "Task"
  ],
  "meta": {
    "page": {
      "limit": 1,
      "nextCursor": null
    },
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

cursorquerylimitqueryarchivedqueryassigneeIdquerycompletedquerycontactIdquerygroupIdquerylistIdquerypersonalListIdqueryprojectIdqueryserviceIdquerysubscriberIdquerytagIdquery

Generated cURL

The builder does not execute requests or persist credentials. Replace the environment-variable placeholder only in your terminal or secret-aware runtime.

Query parameters

cursor

string

Opaque cursor returned in meta.page.nextCursor.

limit

integer

Maximum number of records to return in this page. The response may contain fewer records.

archived

boolean

Return archived resources instead of active resources.

assigneeId

string

Filter by assigned user id.

completed

boolean

Filter by completion status.

contactId

string

Filter by related contact id.

groupId

string

Filter by assigned group id.

listId

string

Filter by project task-list id.

personalListId

string

Filter by personal-list id.

projectId

string

Filter by project id.

serviceId

string

Filter by service id.

subscriberId

string

Filter by subscriber user id.

tagId

string

Filter by tag id.

Responses

200A bounded page of resources visible to the credential, with request metadata and an opaque cursor when another page is available.application/json

Response schemaapplication/json

required

array<Task>

Public API representation of task.

required

object

400The request is invalid.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

401The bearer credential is missing, invalid, expired, or revoked.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

403The credential has insufficient scope.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

429The credential or source exceeded its rate limit.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

503A required cell-local dependency is unavailable.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

Operation IDlistTasksOpenAPI JSON ↗

Documentation feedbackWas this page useful?