Authzed · Schema

ReadRelationshipsRequest

ReadRelationshipsRequest specifies one or more filters used to read matching relationships within the system.

AuthorizationAccess ControlPermissionsZanzibarSpiceDBgRPCRESTRelationship-Based Access ControlReBACFine-Grained AuthorizationIdentitySecurity

Properties

Name Type Description
consistency object
relationshipFilter object relationship_filter defines the filter to be applied to the relationships to be returned.
optionalLimit integer optional_limit, if non-zero, specifies the limit on the number of relationships to return before the stream is closed on the server side. By default, the stream will continue resolving relationships u
optionalCursor object optional_cursor, if specified, indicates the cursor after which results should resume being returned. The cursor can be found on the ReadRelationshipsResponse object.
View JSON Schema on GitHub

JSON Schema

ReadRelationshipsRequest.json Raw ↑
{
  "type": "object",
  "properties": {
    "consistency": {
      "$ref": "#/components/schemas/Consistency"
    },
    "relationshipFilter": {
      "$ref": "#/components/schemas/RelationshipFilter",
      "description": "relationship_filter defines the filter to be applied to the relationships\nto be returned."
    },
    "optionalLimit": {
      "type": "integer",
      "format": "int64",
      "description": "optional_limit, if non-zero, specifies the limit on the number of relationships to return\nbefore the stream is closed on the server side. By default, the stream will continue\nresolving relationships until exhausted or the stream is closed due to the client or a\nnetwork issue."
    },
    "optionalCursor": {
      "$ref": "#/components/schemas/v1.Cursor",
      "description": "optional_cursor, if specified, indicates the cursor after which results should resume being returned.\nThe cursor can be found on the ReadRelationshipsResponse object."
    }
  },
  "description": "ReadRelationshipsRequest specifies one or more filters used to read matching\nrelationships within the system.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/authzed/main/json-schema/ReadRelationshipsRequest.json",
  "title": "ReadRelationshipsRequest"
}

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/ReadRelationshipsRequest"
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.