pub.chive.claiming.getClaim Documentation (EN)

main query

Get a claim request by ID. Users can only view their own claims unless they are admins.

Parameters

claimId integer Required

ID of the claim request

Output

Encodingapplication/json

claim ref#claimRequest Optional

The claim request, or null if not found or not authorized

Errors

AuthenticationRequired Authentication is required to get claims

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

claimId * ID of the claim request

View raw schema

{
  "description": "Get a claim request by ID. Users can only view their own claims unless they are admins.",
  "errors": [
    {
      "description": "Authentication is required to get claims",
      "name": "AuthenticationRequired"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "claim": {
          "description": "The claim request, or null if not found or not authorized",
          "ref": "#claimRequest",
          "type": "ref"
        }
      },
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "claimId": {
        "description": "ID of the claim request",
        "minimum": 1,
        "type": "integer"
      }
    },
    "required": [
      "claimId"
    ],
    "type": "params"
  },
  "type": "query"
}

claimRequest object

A claim request for an imported eprint

Properties

canonicalUri string at-uri Optional

AT-URI of the canonical record once created

claimantDid string did Required

DID of the user making the claim

createdAt string datetime Required

When the claim was created

expiresAt string datetime Optional

When the claim expires if not completed

id integer Required

Unique claim request ID

importId integer Required

ID of the imported eprint being claimed

rejectionReason string Optional

Reason for rejection if rejected

reviewedAt string datetime Optional

When the claim was reviewed

reviewedBy string did Optional

DID of the admin who reviewed the claim

status string Required

Current status of the claim

Known values: pending, approved, rejected, expired

View raw schema

{
  "description": "A claim request for an imported eprint",
  "properties": {
    "canonicalUri": {
      "description": "AT-URI of the canonical record once created",
      "format": "at-uri",
      "type": "string"
    },
    "claimantDid": {
      "description": "DID of the user making the claim",
      "format": "did",
      "type": "string"
    },
    "createdAt": {
      "description": "When the claim was created",
      "format": "datetime",
      "type": "string"
    },
    "expiresAt": {
      "description": "When the claim expires if not completed",
      "format": "datetime",
      "type": "string"
    },
    "id": {
      "description": "Unique claim request ID",
      "type": "integer"
    },
    "importId": {
      "description": "ID of the imported eprint being claimed",
      "type": "integer"
    },
    "rejectionReason": {
      "description": "Reason for rejection if rejected",
      "type": "string"
    },
    "reviewedAt": {
      "description": "When the claim was reviewed",
      "format": "datetime",
      "type": "string"
    },
    "reviewedBy": {
      "description": "DID of the admin who reviewed the claim",
      "format": "did",
      "type": "string"
    },
    "status": {
      "description": "Current status of the claim",
      "knownValues": [
        "pending",
        "approved",
        "rejected",
        "expired"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "importId",
    "claimantDid",
    "status",
    "createdAt"
  ],
  "type": "object"
}