Invites namespace

Reference for previewing company member invites before sign-in.

Look up a company member invite from its link before the person signs in, so your "Join company" page can show the company and the right next step.

Company admins invite teammates with board.me.companies.createInvite. The email links to /employers/invites/accept?token=… on your board. Accepting still needs a signed-in employer; this namespace only reads.

`board.invites.preview()`

1preview(
2  body: PreviewCompanyMemberInviteBody,
3  options?: FetchOptions,
4): Promise<CompanyMemberInvitePreview>

Send the token from the link. The token travels in the request body, not the URL. The result:

Field	Type	Notes
`status`	`'pending' \| 'expired' \| 'accepted' \| 'revoked'`	Only `pending` can be accepted.
`email`	`string \| null`	The invited address. `null` unless `status` is `pending`.
`expiresAt`	`string`	ISO 8601. Invites last 7 days.
`account`	`'none' \| 'employer' \| 'candidate' \| null`	Whether the invited address already has an account on the board. `null` unless `status` is `pending`.
`company`	`{ slug, name, logoUrl }`	The company the invite is for.

1import { isBoardApiError } from '@cavuno/board';
2
3const token = new URL(request.url).searchParams.get('token') ?? '';
4
5try {
6  const invite = await board.invites.preview({ token });
7  if (invite.status !== 'pending') {
8    return { state: 'link_used_or_expired' as const, invite };
9  }
10  if (invite.account === 'none') return { state: 'sign_up' as const, invite };
11  if (invite.account === 'employer') return { state: 'sign_in' as const, invite };
12  return { state: 'candidate_account' as const, invite };
13} catch (error) {
14  if (isBoardApiError(error) && error.code === 'employer_invite_not_found') {
15    return { state: 'not_found' as const };
16  }
17  throw error;
18}

Signing up from an invite

Prefill the sign-up form with invite.email and pass the token to register as inviteToken. When it matches a pending invite for the same email, no verification email is sent, because accepting the invite verifies the address. Then accept the invite:

1await board.auth.register({
2  role: 'employer',
3  method: 'emailpass',
4  email: invite.email!,
5  password,
6  displayName,
7  inviteToken: token,
8});
9const { companySlug } = await board.me.acceptInvite({ token });

Registration never accepts the invite itself. A token that does not match is ignored and the verification email is sent as usual.

Errors

employer_invite_not_found (404): no invite on this board matches the token, or the company no longer exists.
board_auth_registration_disabled (403): employer accounts are turned off on this board.