pub.chive.governance.listDelegations

chive.pub

Documentation

List active PDS delegations. Only accessible by administrators.

main query

List active PDS delegations. Only accessible by administrators.

Parameters

cursor string Optional

Pagination cursor for next page

limit integer Optional

Maximum number of results to return

Output

Encodingapplication/json
cursor string Optional

Cursor for next page

delegations array Required

List of delegations

total integer Required

Total number of delegations

Errors

AuthenticationRequired
Unauthorized
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Pagination cursor for next page
Maximum number of results to return
View raw schema 
{
  "type": "query",
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "Unauthorized"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "delegations",
        "total"
      ],
      "properties": {
        "total": {
          "type": "integer",
          "description": "Total number of delegations"
        },
        "cursor": {
          "type": "string",
          "description": "Cursor for next page"
        },
        "delegations": {
          "type": "array",
          "items": {
            "ref": "#delegation",
            "type": "ref"
          },
          "description": "List of delegations"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "limit": {
        "type": "integer",
        "default": 20,
        "maximum": 100,
        "minimum": 1,
        "description": "Maximum number of results to return"
      },
      "cursor": {
        "type": "string",
        "description": "Pagination cursor for next page"
      }
    }
  },
  "description": "List active PDS delegations. Only accessible by administrators."
}
delegation object

PDS delegation record

Properties

active boolean Required

Whether the delegation is currently active

collections array of string Required

NSID collections the delegation covers

delegateDid string did Required

DID of the delegate

displayName string Optional

Delegate display name

expiresAt integer Required

Expiration timestamp

grantedAt integer Required

Timestamp when delegation was granted

grantedBy string did Required

DID of admin who granted the delegation

handle string Optional

Delegate handle

id string Required

Delegation identifier

maxRecordsPerDay integer Required

Maximum records delegate can create per day

minimum: 0
recordsCreatedToday integer Required

Records created today under this delegation

minimum: 0
View raw schema 
{
  "type": "object",
  "required": [
    "id",
    "delegateDid",
    "collections",
    "expiresAt",
    "maxRecordsPerDay",
    "recordsCreatedToday",
    "grantedAt",
    "grantedBy",
    "active"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Delegation identifier"
    },
    "active": {
      "type": "boolean",
      "description": "Whether the delegation is currently active"
    },
    "handle": {
      "type": "string",
      "description": "Delegate handle"
    },
    "expiresAt": {
      "type": "integer",
      "description": "Expiration timestamp"
    },
    "grantedAt": {
      "type": "integer",
      "description": "Timestamp when delegation was granted"
    },
    "grantedBy": {
      "type": "string",
      "format": "did",
      "description": "DID of admin who granted the delegation"
    },
    "collections": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "NSID collections the delegation covers"
    },
    "delegateDid": {
      "type": "string",
      "format": "did",
      "description": "DID of the delegate"
    },
    "displayName": {
      "type": "string",
      "description": "Delegate display name"
    },
    "maxRecordsPerDay": {
      "type": "integer",
      "minimum": 0,
      "description": "Maximum records delegate can create per day"
    },
    "recordsCreatedToday": {
      "type": "integer",
      "minimum": 0,
      "description": "Records created today under this delegation"
    }
  },
  "description": "PDS delegation record"
}

Lexicon Garden

@