social.colibri.beta.polyfill.listRecords

Lists records of one collection in the requesting user's repo in a space the AppView hosts for them, ordered by record key.

Repository @colibri.social did:plc:mprdjqjluoswa7awzggaggj3 namespace authority
Details · query
Kindquery
Authoritypolyfill.beta.colibri.social
Commit rev3n2beo2y7xt22
Indexed

Query

query · GET

Parameters

query string

collection

requiredstring · nsid

The record's collection.

cursor

string

Where the next page starts.

limit

integer

The page size.

  • minimum: 1
  • maximum: 100
  • default: 50

reverse

boolean

Newest record key first.

space

requiredstring · space-ref

The space holding the repo.

Output

application/json

cursor

string

Where the next page starts.

records

requiredarray

The records on this page.

Errors

AuthRequired

The request has no valid service auth.

InvalidRequest

The arguments are inconsistent or malformed beyond schema validation.

SpaceNotFound

No space matches the given space reference.

NotAuthorized

The caller may not write to or read from this repo in the space.

RepoNotHosted

The AppView does not host the caller's repo in this space, because it lives on the caller's PDS. Write to the PDS instead.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • Pages through every record in the requesting user's hosted repo in one space, in record key order per collection, so the client can replay them on its PDS.

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

  • List records of a given collection within a space. Access is governed by the space's collection policy.

  • Records in one of a group's content spaces, from the host's index of it: one collection or every collection, newest first, a page at a time. Only for those the space's own access record lets read, checked on every call — anyone, signed in or not, for one open to anyone.

  • Reads one record from the requesting user's repo in a space the AppView hosts for them.