# pub.chive.collaboration.listInvites

> Published by [chive.pub](https://lexicon.garden/identity/did:plc:7natp5xae72bddaqlkef2t4e)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.collaboration.listInvites)
- [Documentation](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.collaboration.listInvites/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.collaboration.listInvites/examples)

## Definitions

### `pub.chive.collaboration.listInvites`

**Type**: `query`

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

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `limit` | `integer` | No |  |
| `state` | `string` | No | Acceptance-derived state filter. |
| `cursor` | `string` | No |  |
| `invitee` | `string` (did) | No | Filter to invites directed at this DID. |
| `inviter` | `string` (did) | No | Filter to invites authored by this DID. |
| `subjectUri` | `string` (at-uri) | No | Filter to invites for this subject record. |
| `subjectCollection` | `string` | No | Filter to invites where the subject's NSID matches (e.g., `pub.chive.graph.node` for collections). |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `total` | `integer` | No |  |
| `cursor` | `string` | No |  |
| `hasMore` | `boolean` | No |  |
| `invites` | `array` | Yes |  |

### `pub.chive.collaboration.listInvites#inviteView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `uri` | `string` (at-uri) | Yes |  |
| `role` | `string` | No |  |
| `state` | `string` | Yes |  |
| `invitee` | `string` (did) | Yes |  |
| `inviter` | `string` (did) | Yes |  |
| `message` | `string` | No |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `expiresAt` | `string` (datetime) | No |  |
| `acceptedAt` | `string` (datetime) | No |  |
| `subjectUri` | `string` (at-uri) | Yes |  |
| `acceptanceUri` | `string` (at-uri) | No |  |
| `subjectCollection` | `string` | No |  |

## Raw Schema

```json
{
  "id": "pub.chive.collaboration.listInvites",
  "defs": {
    "main": {
      "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": {
      "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"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "revision": 1
}
```