Ampersand · JSON Structure

Ampersand Api Pagination Info Structure

PaginationInfo schema from Ampersand API

Type: object Properties: 2 Required: 1
Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

PaginationInfo is a JSON Structure definition published by Ampersand, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

done nextPageToken

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-structure/ampersand-api-pagination-info-structure.json",
  "name": "PaginationInfo",
  "description": "PaginationInfo schema from Ampersand API",
  "type": "object",
  "properties": {
    "done": {
      "type": "boolean",
      "description": "If set to true, this is the last page of results for the given operation. There are no more results & there will be no nextPageToken sent when done is true.",
      "example": false
    },
    "nextPageToken": {
      "type": "string",
      "description": "If present, set this value against your 'pageToken' query parameter in the next API call, which will retrieve the next set of results.",
      "example": "Q9JT+2qfys28V4ODN+UayA=="
    }
  },
  "required": [
    "done"
  ]
}