Lexicon Garden

fyi.opensocial.listSiteRecords

Records of one collection from the host's index, newest first. Without `repo`, a collection the group's site declares it reads, from the group (answered to anyone) or its members (members only). With `repo`, that one account's records — the group's or a member's — of any collection, kept on demand once asked for; members only. `field` and `equals` keep only records whose field (a name, or a path like subject.uri) equals that value. With `from: "network"`, everyone's records of the collection, from every account on the network that writes it: answered to anyone once the host keeps it, which it does from when a saved page declares it, unless too many accounts write it; `filling` says it is still being gathered. With `repos`, each of those accounts' newest record of any collection, such as each one's profile, answered to anyone; an account not heard from in time is left out, and fills in for the next read.

Repository @lexicons.opensocial.fyi did:plc:2gqnilpksz2e7faj3bwvo6qc namespace authority
Details · query
Kindquery
Authorityopensocial.fyi
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

collection

requiredstring · nsid

cursor

string

With `from: "network"`: from the last page, for older records.

  • maxLength: 1024

equals

string
  • maxLength: 2048

field

string

Only records whose field (a name or a dotted path) equals `equals`.

  • maxLength: 128

from

string

Without `repo`: the group's records, its members', or everyone's on the network.

  • knownValues: group | members | network

group

requiredstring · did

limit

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

repo

string · did

One account's records: the group's or a member's.

repos

array

Many accounts, anyone's: each one's newest record of the collection.

  • maxLength: 100
itemsstring · did

sort

string

With `from: "network"` and a search: newest first, or the most relevant first.

  • default: "newest"
  • knownValues: newest | relevance

Output

application/json

cursor

string

With `from: "network"`, when there are older records.

filling

boolean

With `from: "network"`: the host is still gathering the collection, so older records may be missing.

records

requiredarray
itemsref
Reference

Errors

NotFound

No description in schema.

NotDeclared

No description in schema.

NotAuthorized

No description in schema.

NotKept

No description in schema.

TooLarge

No description in schema.

TooMany

No description in schema.

#siteRecord

object

Properties

cid

string · cid

createdAt

string · datetime

handle

string · handle

With `from: "network"` or `repos`: the account's handle, when it's known.

repo

requiredstring · did

uri

requiredstring · at-uri

value

requiredunknown

Similar lexicons

semantic match

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

  • fyi.opensocial.listSpaceRecords

    query

    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.

  • fyi.opensocial.getSiteRecord

    query

    One public record a group's site reads, by URI, from the host's index: of a collection the site reads from everyone (answered to anyone), or the group's own or a member's of a collection it reads (a member's to members only). Anything else isn't the site's to read, except to whoever may change the site, for whom the host reads it from the account's own server: what a tab is about, when it's made.

  • com.atproto.repo.listRecords

    query

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

  • us.off-the-clock.listSpaceRecords

    query

    The visible records of one collection in one community space, newest first or by start time from now.