Codat · Schema

Pagination information

Unified-API

Properties

Name Type Description
pageNumber integer Current page number.
pageSize integer Number of items to return in results array.
totalResults integer Total number of items.
_links object
View JSON Schema on GitHub

JSON Schema

codat-paginginfo-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PagingInfo",
  "title": "Pagination information",
  "type": "object",
  "x-internal": true,
  "properties": {
    "pageNumber": {
      "type": "integer",
      "description": "Current page number."
    },
    "pageSize": {
      "type": "integer",
      "description": "Number of items to return in results array.",
      "maximum": 2000
    },
    "totalResults": {
      "type": "integer",
      "description": "Total number of items."
    },
    "_links": {
      "$ref": "#/components/schemas/PagingInfo/definitions/links"
    }
  },
  "definitions": {
    "links": {
      "title": "Hal Links",
      "type": "object",
      "required": [
        "self",
        "current"
      ],
      "properties": {
        "self": {
          "$ref": "#/components/schemas/PagingInfo/definitions/halRef"
        },
        "current": {
          "$ref": "#/components/schemas/PagingInfo/definitions/halRef"
        },
        "next": {
          "$ref": "#/components/schemas/PagingInfo/definitions/halRef"
        },
        "previous": {
          "$ref": "#/components/schemas/PagingInfo/definitions/halRef"
        }
      },
      "examples": [
        {
          "self": {
            "href": "/companies"
          },
          "current": {
            "href": "/companies?page=1&pageSize=10"
          }
        }
      ]
    },
    "halRef": {
      "title": "Hypertext reference",
      "type": "object",
      "properties": {
        "href": {
          "type": "string",
          "format": "uri-reference",
          "description": "Uri hypertext reference."
        }
      }
    }
  },
  "required": [
    "pageNumber",
    "pageSize",
    "totalResults",
    "_links"
  ],
  "examples": [
    {
      "pageNumber": 1,
      "pageSize": 10,
      "totalResults": 1,
      "_links": {
        "self": {
          "href": "/companies/{id}/data/{dataType}"
        },
        "current": {
          "href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"
        }
      }
    }
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/codat-paginginfo"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.