Profile fields namespace

Use board.profileFields to discover the public scalar fields and collection-reference fields a headless board can display or offer as company and talent search filters. These reads require no board-user session. Private definitions and archived collection choices are excluded.

Shared behavior

Every method returns the Board API wire body unchanged and throws BoardApiError for a non-2xx response. The final FetchOptions argument passes abort signals, headers, and framework cache directives through to fetch.

Collection creation, entry mutation, and imports belong to the server-side operator API. The Board SDK exposes public discovery and signed-in owner profile operations, without accepting an operator API key.

board.profileFields.retrieve

Retrieve the public profile-field definitions for companies or candidates.

The result contains definitions for scalar fields and referenceDefinitions for collection-backed fields. Use the stored key in a search filter and the label, type, options, limits, and multiplicity to render controls. A multi-select reference definition may carry maxSelections, the operator's own cap on how many entries a profile can choose; when it is absent, the platform ceiling of 100 applies.

An unavailable board returns 404. The entity is part of the path and must be company or candidate.

board.profileFields.choices

List active public choices for one public collection-reference field.

ProfileChoiceQuery accepts search, an opaque cursor, and limit. Each row contains the collection entry's id, name, and optional logoUrl. Submit id as an objectReferences[].recordIds value; do not derive IDs from names.

An unknown, private, or archived reference field returns 404. Follow nextCursor unchanged with the same entity, field key, search text, and limit.

Signed-in candidates and approved company members can search choices for private owner-editable fields through board.me.