Outline · Example Payload

Userslist

Users

Userslist is an example object payload from Outline, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdpathmethodsummarytagsrequestSchema

Example Payload

Raw ↑
{
  "operationId": "usersList",
  "path": "/users.list",
  "method": "POST",
  "summary": "List all users",
  "tags": [
    "Users"
  ],
  "requestSchema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Pagination"
      },
      {
        "$ref": "#/components/schemas/Sorting"
      },
      {
        "type": "object",
        "properties": {
          "query": {
            "type": "string",
            "example": "jane"
          },
          "emails": {
            "type": "array",
            "description": "Array of emails",
            "items": {
              "type": "string"
            },
            "example": [
              "jane.crandall@mail.com",
              "prudence.crandall@mail.com"
            ]
          },
          "filter": {
            "type": "string",
            "description": "The status to filter by",
            "enum": [
              "all",
              "invited",
              "active",
              "suspended"
            ]
          },
          "role": {
            "$ref": "#/components/schemas/UserRole"
          }
        }
      }
    ]
  }
}

Work with this as data

Every example 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 examples

4 MCP tools reach this
  • find_examplesBrowse and filter every example 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 example
curl "https://apis.io/api/v1/examples/usersList"
All examples
curl "https://apis.io/api/v1/examples?limit=25"

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

Get an API key

Free tier, no email required.

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