SocialluxSociallux
Toggle navigation menu
Docs navigationv

Primitive

atom.list

BETA

Short name: list

Version: 1.0.0

System primitive that queries atoms visible to the authenticated user. Supports filtering by lexeme, scope, visibility, and organization. Returns a paginated array of serialized atoms.

Back to primitive library

Inputs

KeyTypeRequiredDescription
isPublicbooleanfalseFilter by public visibility. true = only public atoms, false = only private atoms. Omit for no filter.
lexemeIdobjectIdfalseFilter to atoms subscribed to this lexeme. Omit to return atoms of any lexeme.
limitnumberfalseResults per page. Defaults to 20; maximum 100.
organizationAtomIdobjectIdfalseScope results to atoms owned by a specific organization atom. User must be a member or admin.
pagenumberfalse1-indexed page number. page=1 returns items 1–limit, page=2 returns items (limit+1)–(2*limit), etc. Defaults to 1.
personalOnlybooleanfalseWhen true, excludes organization-owned atoms and returns only personally owned atoms.
sandboxSessionIdstringfalseOpt-in: when set, returns ONLY atoms tagged with this sandbox session id. When omitted, sandboxed atoms are excluded from results.
scopestringfalseVisibility scope: "own" (atoms you own or manage, default), "share" (atoms explicitly shared with you), or "all" (all visible atoms).

Outputs

KeyTypeRequiredDescription
atomsarrayfalseSerialized atom objects matching the query. Private fields are stripped for non-managers.
paginationobjectfalsePagination metadata: { page, limit, total, totalPages }.