pub.chive.claiming.getCoauthorRequests Documentation (EN)

main query

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

Parameters

cursor string Optional

Pagination cursor for next page

limit integer Optional

Maximum number of results to return

Output

Encodingapplication/json

cursor string Optional

Cursor for next page of results

requests array Required

List of co-author requests

Errors

AuthenticationRequired Authentication is required to get co-author requests

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

limit Maximum number of results to return

View raw schema

{
  "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 object

A co-author claim request

Properties

authorIndex integer Required

Index of the author entry being claimed (0-based)

minimum: 0

authorName string Required

Name of the author entry being claimed

claimantDid string did Required

DID of the user requesting co-authorship

claimantName string Required

Display name of the claimant at time of request

createdAt string datetime Required

When the request was created

eprintOwnerDid string did Required

DID of the eprint owner (PDS owner)

eprintUri string at-uri Required

AT-URI of the eprint record

id integer Required

Unique request ID

message string Optional

Optional message from the claimant

maxLength: 1000 bytes

rejectionReason string Optional

Reason for rejection if rejected

maxLength: 500 bytes

reviewedAt string datetime Optional

When the request was reviewed

status string Required

Current status of the request

Known values: pending, approved, rejected

View raw schema

{
  "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"
}