Asana · Schema

NextPage

*Conditional*. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.

CollaborationProductivityProject ManagementProjectsTask ManagementTasksWorkflow

Properties

Name Type Description
offset string Pagination offset for the request.
path string A relative path containing the query parameters to fetch for next_page
uri string A full uri containing the query parameters to fetch for next_page
View JSON Schema on GitHub

JSON Schema

asana-nextpage-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/NextPage",
  "title": "NextPage",
  "type": "object",
  "nullable": true,
  "description": "*Conditional*. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.",
  "properties": {
    "offset": {
      "type": "string",
      "readOnly": true,
      "description": "Pagination offset for the request.",
      "example": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9"
    },
    "path": {
      "type": "string",
      "readOnly": true,
      "description": "A relative path containing the query parameters to fetch for next_page",
      "example": "/tasks/12345/attachments?limit=2&offset=eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9"
    },
    "uri": {
      "type": "string",
      "format": "uri",
      "readOnly": true,
      "description": "A full uri containing the query parameters to fetch for next_page",
      "example": "https://app.asana.com/api/1.0/tasks/12345/attachments?limit=2&offset=eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9"
    }
  }
}