# pub.chive.collaboration.listCollaborators

> 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.listCollaborators)
- [Documentation](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.collaboration.listCollaborators/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.collaboration.listCollaborators/examples)

## Definitions

### `pub.chive.collaboration.listCollaborators`

**Type**: `query`

List active collaborators on a subject record (DIDs that have both a non-deleted invite from the subject's author and a non-deleted acceptance of that invite).

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `subjectUri` | `string` (at-uri) | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `collaborators` | `array` | Yes |  |

### `pub.chive.collaboration.listCollaborators#collaboratorView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes |  |
| `role` | `string` | No |  |
| `inviteUri` | `string` (at-uri) | Yes |  |
| `acceptedAt` | `string` (datetime) | Yes |  |
| `acceptanceUri` | `string` (at-uri) | Yes |  |

## Raw Schema

```json
{
  "id": "pub.chive.collaboration.listCollaborators",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "collaborators"
          ],
          "properties": {
            "collaborators": {
              "type": "array",
              "items": {
                "ref": "#collaboratorView",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "subjectUri"
        ],
        "properties": {
          "subjectUri": {
            "type": "string",
            "format": "at-uri"
          }
        }
      },
      "description": "List active collaborators on a subject record (DIDs that have both a non-deleted invite from the subject's author and a non-deleted acceptance of that invite)."
    },
    "collaboratorView": {
      "type": "object",
      "required": [
        "did",
        "inviteUri",
        "acceptanceUri",
        "acceptedAt"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did"
        },
        "role": {
          "type": "string"
        },
        "inviteUri": {
          "type": "string",
          "format": "at-uri"
        },
        "acceptedAt": {
          "type": "string",
          "format": "datetime"
        },
        "acceptanceUri": {
          "type": "string",
          "format": "at-uri"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "revision": 1
}
```