pub.chive.governance.listProposals

chive.pub View official

Documentation

List governance proposals with optional filtering by status, type, and other criteria

main query

List governance proposals with optional filtering by status, type, and other criteria

Parameters

cursor string Optional

Pagination cursor for next page

kind string Optional

Filter by node kind

limit integer Optional

Maximum number of results to return

nodeUri string at-uri Optional

Filter by target node URI

proposedBy string did Optional

Filter by proposer DID

status string Optional

Filter by proposal status

subkind string Optional

Filter by subkind (field, institution, etc.)

type string Optional

Filter by proposal type

Output

Encodingapplication/json

cursor string Optional

Cursor for next page

proposals array Required

List of proposals

total integer Required

Total number of proposals matching filters

Try It

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

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

cursor Pagination cursor for next page

kind Filter by node kind

limit Maximum number of results to return

nodeUri Filter by target node URI

proposedBy Filter by proposer DID

status Filter by proposal status

subkind Filter by subkind (field, institution, etc.)

type Filter by proposal type

View raw schema

{
  "description": "List governance proposals with optional filtering by status, type, and other criteria",
  "errors": [],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cursor": {
          "description": "Cursor for next page",
          "type": "string"
        },
        "proposals": {
          "description": "List of proposals",
          "items": {
            "ref": "#proposalView",
            "type": "ref"
          },
          "type": "array"
        },
        "total": {
          "description": "Total number of proposals matching filters",
          "type": "integer"
        }
      },
      "required": [
        "proposals",
        "total"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "cursor": {
        "description": "Pagination cursor for next page",
        "type": "string"
      },
      "kind": {
        "description": "Filter by node kind",
        "knownValues": [
          "type",
          "object"
        ],
        "type": "string"
      },
      "limit": {
        "default": 50,
        "description": "Maximum number of results to return",
        "maximum": 100,
        "minimum": 1,
        "type": "integer"
      },
      "nodeUri": {
        "description": "Filter by target node URI",
        "format": "at-uri",
        "type": "string"
      },
      "proposedBy": {
        "description": "Filter by proposer DID",
        "format": "did",
        "type": "string"
      },
      "status": {
        "description": "Filter by proposal status",
        "knownValues": [
          "pending",
          "approved",
          "rejected",
          "expired"
        ],
        "type": "string"
      },
      "subkind": {
        "description": "Filter by subkind (field, institution, etc.)",
        "type": "string"
      },
      "type": {
        "description": "Filter by proposal type",
        "knownValues": [
          "create",
          "update",
          "merge",
          "deprecate"
        ],
        "type": "string"
      }
    },
    "type": "params"
  },
  "type": "query"
}

consensusProgress object

No description available.

Properties

approvalPercentage integer Required

Current approval percentage (0-100)

minimum: 0maximum: 100

consensusReached boolean Required

Whether consensus has been reached

minimumVotes integer Required

Minimum votes required

minimum: 0

recommendedStatus string Required

Recommended status based on votes

Known values: approved, rejected, pending

threshold integer Required

Required threshold for approval (0-100)

minimum: 0maximum: 100

voterCount integer Required

Number of voters

minimum: 0

View raw schema

{
  "properties": {
    "approvalPercentage": {
      "description": "Current approval percentage (0-100)",
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    },
    "consensusReached": {
      "description": "Whether consensus has been reached",
      "type": "boolean"
    },
    "minimumVotes": {
      "description": "Minimum votes required",
      "minimum": 0,
      "type": "integer"
    },
    "recommendedStatus": {
      "description": "Recommended status based on votes",
      "knownValues": [
        "approved",
        "rejected",
        "pending"
      ],
      "type": "string"
    },
    "threshold": {
      "description": "Required threshold for approval (0-100)",
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    },
    "voterCount": {
      "description": "Number of voters",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "approvalPercentage",
    "threshold",
    "voterCount",
    "minimumVotes",
    "consensusReached",
    "recommendedStatus"
  ],
  "type": "object"
}

externalId object

No description available.

Properties

identifier string Required

Identifier in external system

matchType string Optional

Match type

Known values: exact, close, broader, narrower, related

system string Required

External system name

uri string uri Optional

URI in external system

View raw schema

{
  "properties": {
    "identifier": {
      "description": "Identifier in external system",
      "type": "string"
    },
    "matchType": {
      "description": "Match type",
      "knownValues": [
        "exact",
        "close",
        "broader",
        "narrower",
        "related"
      ],
      "type": "string"
    },
    "system": {
      "description": "External system name",
      "type": "string"
    },
    "uri": {
      "description": "URI in external system",
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "system",
    "identifier"
  ],
  "type": "object"
}

proposalChanges object

Proposed changes to a node

Properties

alternateLabels array of string Optional

Alternate labels

description string Optional

Node description

externalIds array of ref#externalId Optional

External identifiers

kind string Optional

Node kind

Known values: type, object

label string Optional

Node label

mergeIntoUri string at-uri Optional

Merge target URI

metadata unknown Optional

Additional metadata

subkind string Optional

Node subkind

targetUri string at-uri Optional

Target URI for update/deprecate

View raw schema

{
  "description": "Proposed changes to a node",
  "properties": {
    "alternateLabels": {
      "description": "Alternate labels",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "description": {
      "description": "Node description",
      "type": "string"
    },
    "externalIds": {
      "description": "External identifiers",
      "items": {
        "ref": "#externalId",
        "type": "ref"
      },
      "type": "array"
    },
    "kind": {
      "description": "Node kind",
      "knownValues": [
        "type",
        "object"
      ],
      "type": "string"
    },
    "label": {
      "description": "Node label",
      "type": "string"
    },
    "mergeIntoUri": {
      "description": "Merge target URI",
      "format": "at-uri",
      "type": "string"
    },
    "metadata": {
      "description": "Additional metadata",
      "type": "unknown"
    },
    "subkind": {
      "description": "Node subkind",
      "type": "string"
    },
    "targetUri": {
      "description": "Target URI for update/deprecate",
      "format": "at-uri",
      "type": "string"
    }
  },
  "type": "object"
}

proposalView object

View of a governance proposal

Properties

changes ref #proposalChanges Required

Proposed changes

cid string Required

Content identifier

consensus ref #consensusProgress Required

No description available.

createdAt string datetime Required

Creation timestamp

expiresAt string datetime Optional

Expiration timestamp

id string Required

Proposal identifier

label string Optional

Node label (from target node or proposed changes)

nodeUri string at-uri Optional

Target node URI (for update/merge/deprecate)

proposedBy string did Required

DID of the proposer

proposerName string Optional

Display name of the proposer

rationale string Optional

Rationale for the proposal

status string Required

Current proposal status

Known values: pending, approved, rejected, expired

type string Required

Proposal type

Known values: create, update, merge, deprecate

updatedAt string datetime Optional

Last update timestamp

uri string at-uri Required

Proposal AT-URI

votes ref #voteCounts Required

No description available.

View raw schema

{
  "description": "View of a governance proposal",
  "properties": {
    "changes": {
      "description": "Proposed changes",
      "ref": "#proposalChanges",
      "type": "ref"
    },
    "cid": {
      "description": "Content identifier",
      "type": "string"
    },
    "consensus": {
      "ref": "#consensusProgress",
      "type": "ref"
    },
    "createdAt": {
      "description": "Creation timestamp",
      "format": "datetime",
      "type": "string"
    },
    "expiresAt": {
      "description": "Expiration timestamp",
      "format": "datetime",
      "type": "string"
    },
    "id": {
      "description": "Proposal identifier",
      "type": "string"
    },
    "label": {
      "description": "Node label (from target node or proposed changes)",
      "type": "string"
    },
    "nodeUri": {
      "description": "Target node URI (for update/merge/deprecate)",
      "format": "at-uri",
      "type": "string"
    },
    "proposedBy": {
      "description": "DID of the proposer",
      "format": "did",
      "type": "string"
    },
    "proposerName": {
      "description": "Display name of the proposer",
      "type": "string"
    },
    "rationale": {
      "description": "Rationale for the proposal",
      "type": "string"
    },
    "status": {
      "description": "Current proposal status",
      "knownValues": [
        "pending",
        "approved",
        "rejected",
        "expired"
      ],
      "type": "string"
    },
    "type": {
      "description": "Proposal type",
      "knownValues": [
        "create",
        "update",
        "merge",
        "deprecate"
      ],
      "type": "string"
    },
    "updatedAt": {
      "description": "Last update timestamp",
      "format": "datetime",
      "type": "string"
    },
    "uri": {
      "description": "Proposal AT-URI",
      "format": "at-uri",
      "type": "string"
    },
    "votes": {
      "ref": "#voteCounts",
      "type": "ref"
    }
  },
  "required": [
    "id",
    "uri",
    "cid",
    "type",
    "changes",
    "status",
    "proposedBy",
    "votes",
    "consensus",
    "createdAt"
  ],
  "type": "object"
}

voteCounts object

No description available.

Properties

abstain integer Required

Number of abstain votes

minimum: 0

approve integer Required

Number of approve votes

minimum: 0

reject integer Required

Number of reject votes

minimum: 0

View raw schema

{
  "properties": {
    "abstain": {
      "description": "Number of abstain votes",
      "minimum": 0,
      "type": "integer"
    },
    "approve": {
      "description": "Number of approve votes",
      "minimum": 0,
      "type": "integer"
    },
    "reject": {
      "description": "Number of reject votes",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "approve",
    "reject",
    "abstain"
  ],
  "type": "object"
}