pub.chive.endorsement.listForEprint

chive.pub

Documentation

List endorsements for a specific eprint with optional filtering

main query

List endorsements for a specific eprint with optional filtering

Parameters

contributionType string Optional

Filter by contribution type

cursor string Optional

Pagination cursor for next page

eprintUri string at-uri Required

AT-URI of the eprint

limit integer Optional

Maximum number of results to return

Output

Encodingapplication/json
cursor string Optional

Cursor for next page

endorsements array Required

List of endorsements

hasMore boolean Required

Whether more results are available

total integer Optional

Total number of endorsements

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Filter by contribution type
Pagination cursor for next page
AT-URI of the eprint
Maximum number of results to return
View raw schema
{
  "type": "query",
  "errors": [],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "endorsements",
        "hasMore"
      ],
      "properties": {
        "total": {
          "type": "integer",
          "description": "Total number of endorsements"
        },
        "cursor": {
          "type": "string",
          "description": "Cursor for next page"
        },
        "hasMore": {
          "type": "boolean",
          "description": "Whether more results are available"
        },
        "summary": {
          "ref": "#endorsementSummary",
          "type": "ref",
          "description": "Aggregated summary"
        },
        "endorsements": {
          "type": "array",
          "items": {
            "ref": "#endorsementView",
            "type": "ref"
          },
          "description": "List of endorsements"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "eprintUri"
    ],
    "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"
      },
      "eprintUri": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of the eprint"
      },
      "contributionType": {
        "type": "string",
        "description": "Filter by contribution type",
        "knownValues": [
          "methodological",
          "analytical",
          "theoretical",
          "empirical",
          "conceptual",
          "technical",
          "data",
          "replication",
          "reproducibility",
          "synthesis",
          "interdisciplinary",
          "pedagogical",
          "visualization",
          "societal-impact",
          "clinical"
        ]
      }
    }
  },
  "description": "List endorsements for a specific eprint with optional filtering"
}
authorRef object

No description available.

Properties

avatar string uri Optional

A valid URI.

did string did Required

A decentralized identifier (DID).

displayName string Optional

No description available.

handle string Optional

No description available.

View raw schema
{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "avatar": {
      "type": "string",
      "format": "uri"
    },
    "handle": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    }
  }
}
endorsementCountByType object

Map of contribution type slug to endorsement count

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Map of contribution type slug to endorsement count"
}
endorsementSummary object

No description available.

Properties

endorserCount integer Required

Unique endorser count

minimum: 0
total integer Required

Total endorsement count

minimum: 0
View raw schema
{
  "type": "object",
  "required": [
    "total",
    "endorserCount",
    "byType"
  ],
  "properties": {
    "total": {
      "type": "integer",
      "minimum": 0,
      "description": "Total endorsement count"
    },
    "byType": {
      "ref": "#endorsementCountByType",
      "type": "ref",
      "description": "Count by contribution type"
    },
    "endorserCount": {
      "type": "integer",
      "minimum": 0,
      "description": "Unique endorser count"
    }
  }
}
endorsementView object

View of an endorsement

Properties

cid string Required

Content identifier

comment string Optional

Optional comment

maxLength: 1000 bytes
contributions array of string Required

Contribution types being endorsed

minLength: 1 items
createdAt string datetime Required

Creation timestamp

endorser ref #authorRef Required

No description available.

eprintUri string at-uri Required

Endorsed eprint AT-URI

updatedAt string datetime Optional

Last update timestamp

uri string at-uri Required

Endorsement AT-URI

View raw schema
{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "eprintUri",
    "endorser",
    "contributions",
    "createdAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "description": "Content identifier"
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "Endorsement AT-URI"
    },
    "comment": {
      "type": "string",
      "maxLength": 1000,
      "description": "Optional comment"
    },
    "endorser": {
      "ref": "#authorRef",
      "type": "ref"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "description": "Creation timestamp"
    },
    "eprintUri": {
      "type": "string",
      "format": "at-uri",
      "description": "Endorsed eprint AT-URI"
    },
    "updatedAt": {
      "type": "string",
      "format": "datetime",
      "description": "Last update timestamp"
    },
    "contributions": {
      "type": "array",
      "items": {
        "type": "string",
        "knownValues": [
          "methodological",
          "analytical",
          "theoretical",
          "empirical",
          "conceptual",
          "technical",
          "data",
          "replication",
          "reproducibility",
          "synthesis",
          "interdisciplinary",
          "pedagogical",
          "visualization",
          "societal-impact",
          "clinical"
        ]
      },
      "minLength": 1,
      "description": "Contribution types being endorsed"
    }
  },
  "description": "View of an endorsement"
}

Lexicon Garden

@