BSV blockchainBSV blockchain

List SHIP records

GET/admin/ship-records

Query Parameters

searchstring

Filter by domain, topic, identity key, or txid.

pageinteger
limitinteger

Response

Paginated SHIP record list.

statusstring
dataobject
Show data properties
recordsobject[]
totalinteger
pageinteger
limitinteger
pagesinteger

No authentication credentials provided.

statusstring
messagestring
codestring

Stable machine-readable error code (see specs/errors.md).

Credentials provided but insufficient.

statusstring
messagestring
codestring

Stable machine-readable error code (see specs/errors.md).

Request
curl -X GET "https://{fqdn}/admin/ship-records?search=<search>&page=<page>&limit=<limit>" \
  -H "Authorization: Bearer <token>" \
  -H "Authorization: Bearer <token>"
Response
{
  "status": "string",
  "data": {
    "records": [
      {}
    ],
    "total": 0,
    "page": 0,
    "limit": 0,
    "pages": 0
  }
}