com.atproto.repo.listRecords

GET 
/xrpc/com.atproto.repo.listRecords

This endpoint is part of the atproto PDS repository management APIs. Requests usually require authentication (unlike the com.atproto.sync.* endpoints), and are made directly to the user's own PDS instance.

To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.

List a range of records in a repository, matching a specific collection. Does not require auth.

Request

Query Parameters

repo at-identifierrequired

The handle or DID of the repo.

collection nsidrequired

The NSID of the record type.

limit integer

Possible values: >= 1 and <= 100

Default value: 50

The number of records to return.

cursor string
reverse boolean

Flag to reverse the order of the returned records.

Responses

200

OK

application/json

Schema

Schema

cursor string

records

object[]

required

Array [

uri at-urirequired

cid cidrequired

value required

]

Example (from schema)

{
  "cursor": "string",
  "records": [
    {
      "uri": "string",
      "cid": "string",
      "value": {}
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

error stringrequired

Possible values: [InvalidRequest, ExpiredToken, InvalidToken]

message stringrequired

Example (from schema)

{
  "error": "InvalidRequest",
  "message": "string"
}

401

Unauthorized

application/json

Schema

Schema

error required
message stringrequired

Example (from schema)

{
  "message": "string"
}

Loading...