pub.chive.collaboration.listInvites

chive.pub

Documentation

List collaboration invites, filtered by invitee, inviter, and/or subject. Typically used to populate an invitee's inbox.

main query

List collaboration invites, filtered by invitee, inviter, and/or subject. Typically used to populate an invitee's inbox.

Parameters

cursor string Optional

No description available.

invitee string did Optional

Filter to invites directed at this DID.

inviter string did Optional

Filter to invites authored by this DID.

limit integer Optional

No description available.

state string Optional

Acceptance-derived state filter.

subjectCollection string Optional

Filter to invites where the subject's NSID matches (e.g., `pub.chive.graph.node` for collections).

subjectUri string at-uri Optional

Filter to invites for this subject record.

Output

Encodingapplication/json
cursor string Optional

No description available.

hasMore boolean Optional

No description available.

invites array Required

No description available.

total integer Optional

No description available.

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
Filter to invites directed at this DID.
Filter to invites authored by this DID.
Acceptance-derived state filter.
Filter to invites where the subject's NSID matches (e.g., `pub.chive.graph.node` for collections).
Filter to invites for this subject record.
View raw schema 
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "invites"
      ],
      "properties": {
        "total": {
          "type": "integer"
        },
        "cursor": {
          "type": "string"
        },
        "hasMore": {
          "type": "boolean"
        },
        "invites": {
          "type": "array",
          "items": {
            "ref": "#inviteView",
            "type": "ref"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1
      },
      "state": {
        "type": "string",
        "default": "all",
        "description": "Acceptance-derived state filter.",
        "knownValues": [
          "pending",
          "accepted",
          "rejected",
          "expired",
          "all"
        ]
      },
      "cursor": {
        "type": "string"
      },
      "invitee": {
        "type": "string",
        "format": "did",
        "description": "Filter to invites directed at this DID."
      },
      "inviter": {
        "type": "string",
        "format": "did",
        "description": "Filter to invites authored by this DID."
      },
      "subjectUri": {
        "type": "string",
        "format": "at-uri",
        "description": "Filter to invites for this subject record."
      },
      "subjectCollection": {
        "type": "string",
        "description": "Filter to invites where the subject's NSID matches (e.g., `pub.chive.graph.node` for collections)."
      }
    }
  },
  "description": "List collaboration invites, filtered by invitee, inviter, and/or subject. Typically used to populate an invitee's inbox."
}
inviteView object

No description available.

Properties

acceptanceUri string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

acceptedAt string datetime Optional

An RFC 3339 formatted timestamp.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

expiresAt string datetime Optional

An RFC 3339 formatted timestamp.

invitee string did Required

A decentralized identifier (DID).

inviter string did Required

A decentralized identifier (DID).

message string Optional

No description available.

role string Optional

No description available.

state string Required

No description available.

Known values: pending, accepted, rejected, expired
subjectCollection string Optional

No description available.

subjectUri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "inviter",
    "invitee",
    "subjectUri",
    "state",
    "createdAt"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "role": {
      "type": "string"
    },
    "state": {
      "type": "string",
      "knownValues": [
        "pending",
        "accepted",
        "rejected",
        "expired"
      ]
    },
    "invitee": {
      "type": "string",
      "format": "did"
    },
    "inviter": {
      "type": "string",
      "format": "did"
    },
    "message": {
      "type": "string"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "expiresAt": {
      "type": "string",
      "format": "datetime"
    },
    "acceptedAt": {
      "type": "string",
      "format": "datetime"
    },
    "subjectUri": {
      "type": "string",
      "format": "at-uri"
    },
    "acceptanceUri": {
      "type": "string",
      "format": "at-uri"
    },
    "subjectCollection": {
      "type": "string"
    }
  }
}

Lexicon Garden

@