Collections namespace

Reference for listing the entries of a public collection.

Use board.collections to render a collection's entries on their own page, such as a Resources or Partners page. The operator chooses which collections a site can read by turning on Public in the collection's settings.

Shared behavior

The method is a public read. It returns the Board API wire body unchanged and throws BoardApiError for a non-2xx response. Its trailing FetchOptions passes abort signals, headers, and framework cache directives through to fetch.

`board.collections.entries`

1board.collections.entries(
2  key: string,
3  query?: { cursor?: string; limit?: number },
4  options?: FetchOptions,
5): Promise<PublicCollectionEntryList>

key is the collection's key from its settings. limit is 1 to 100 and defaults to 25. Entries are active ones only, sorted by name. Follow nextCursor until it is null.

1const entries = [];
2let cursor: string | undefined;
3do {
4  const page = await board.collections.entries('trade_communities', {
5    limit: 100,
6    cursor,
7  });
8  entries.push(...page.data);
9  cursor = page.nextCursor ?? undefined;
10} while (cursor);

Each PublicCollectionEntry contains:

Field	Type	Behavior
`id`	`string`	The entry's ID.
`name`	`string`	The entry's name.
`slug`	`string \| undefined`	URL-safe identifier, unique within the collection. Absent on entries saved before slugs.
`logoUrl`	`string \| undefined`	The image in the collection's logo field, or a legacy logo URL.
`fields`	`ResolvedCollectionFieldDefinition[]`	The collection's public fields in display order, with labels and select options.
`values`	`Record<string, ...>`	Values keyed by public field key. Media values are `{ id, name, contentType, sizeBytes, url }`, an array for an image gallery.
`references`	`Record<string, ...[]> \| undefined`	Entries that public reference fields point at, keyed by field key. Always an array.

Only public fields appear in fields and values. Take labels from fields, render a select value through its options, and insert a rich_text value as HTML.

Errors

A key that is unknown, archived, or not public throws BoardApiError with status 404 and code collections_not_found. Render the page without the section, or ask the operator to turn on Public for that collection.

Use board.jobs.collectionChoices for the entries a job form field can select.
Use board.profileFields.choices for company and talent collection fields.

Shared behavior

board.collections.entries

Errors

Related methods

`board.collections.entries`