# pub.chive.claiming.getCoauthorRequests

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

## Definitions

### `pub.chive.claiming.getCoauthorRequests`

**Type**: `query`

Get pending co-author requests for the authenticated user's eprints. Returns requests where the user is the eprint owner.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `limit` | `integer` | No | Maximum number of results to return |
| `cursor` | `string` | No | Pagination cursor for next page |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No | Cursor for next page of results |
| `requests` | `array` | Yes | List of co-author requests |

#### Errors

- **AuthenticationRequired**: Authentication is required to get co-author requests

### `pub.chive.claiming.getCoauthorRequests#coauthorRequest`

**Type**: `object`

A co-author claim request

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `id` | `integer` | Yes | Unique request ID |
| `status` | `string` | Yes | Current status of the request |
| `message` | `string` | No | Optional message from the claimant |
| `createdAt` | `string` (datetime) | Yes | When the request was created |
| `eprintUri` | `string` (at-uri) | Yes | AT-URI of the eprint record |
| `authorName` | `string` | Yes | Name of the author entry being claimed |
| `reviewedAt` | `string` (datetime) | No | When the request was reviewed |
| `authorIndex` | `integer` | Yes | Index of the author entry being claimed (0-based) |
| `claimantDid` | `string` (did) | Yes | DID of the user requesting co-authorship |
| `claimantName` | `string` | Yes | Display name of the claimant at time of request |
| `eprintOwnerDid` | `string` (did) | Yes | DID of the eprint owner (PDS owner) |
| `rejectionReason` | `string` | No | Reason for rejection if rejected |

## Raw Schema

```json
{
  "id": "pub.chive.claiming.getCoauthorRequests",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "AuthenticationRequired",
          "description": "Authentication is required to get co-author requests"
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "requests"
          ],
          "properties": {
            "cursor": {
              "type": "string",
              "description": "Cursor for next page of results"
            },
            "requests": {
              "type": "array",
              "items": {
                "ref": "#coauthorRequest",
                "type": "ref"
              },
              "description": "List of co-author requests"
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "limit": {
            "type": "integer",
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "description": "Maximum number of results to return"
          },
          "cursor": {
            "type": "string",
            "description": "Pagination cursor for next page"
          }
        }
      },
      "description": "Get pending co-author requests for the authenticated user's eprints. Returns requests where the user is the eprint owner."
    },
    "coauthorRequest": {
      "type": "object",
      "required": [
        "id",
        "eprintUri",
        "eprintOwnerDid",
        "claimantDid",
        "claimantName",
        "authorIndex",
        "authorName",
        "status",
        "createdAt"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "description": "Unique request ID"
        },
        "status": {
          "type": "string",
          "description": "Current status of the request",
          "knownValues": [
            "pending",
            "approved",
            "rejected"
          ]
        },
        "message": {
          "type": "string",
          "maxLength": 1000,
          "description": "Optional message from the claimant"
        },
        "createdAt": {
          "type": "string",
          "format": "datetime",
          "description": "When the request was created"
        },
        "eprintUri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the eprint record"
        },
        "authorName": {
          "type": "string",
          "description": "Name of the author entry being claimed"
        },
        "reviewedAt": {
          "type": "string",
          "format": "datetime",
          "description": "When the request was reviewed"
        },
        "authorIndex": {
          "type": "integer",
          "minimum": 0,
          "description": "Index of the author entry being claimed (0-based)"
        },
        "claimantDid": {
          "type": "string",
          "format": "did",
          "description": "DID of the user requesting co-authorship"
        },
        "claimantName": {
          "type": "string",
          "description": "Display name of the claimant at time of request"
        },
        "eprintOwnerDid": {
          "type": "string",
          "format": "did",
          "description": "DID of the eprint owner (PDS owner)"
        },
        "rejectionReason": {
          "type": "string",
          "maxLength": 500,
          "description": "Reason for rejection if rejected"
        }
      },
      "description": "A co-author claim request"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "revision": 1
}
```