Get a board member

Fetches one board seat by its own id, whether or not the member is still serving. Requires the hoa_board_members:read permission.

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

boardMemberIdstringrequired

The board seat to fetch. This is the seat's id, not the owner's.

example: 1830472847398409216

Response

200 · The board seat.

idstring

The board seat. A 64-bit id sent as a decimal string.

companyIdstring

The company the seat belongs to.

ownerIdstring

The owner who holds the seat.

activeboolean

true while the owner is serving. An inactive row is the record of a past seat.

rolestring

Free text describing the seat, for example President. Absent when none was given.

seatStartedAtstring · date-time

When the seat began, in the company's timezone. Set to the moment of appointment.

seatEndedAtstring · date-time

When the seat ended, in the company's timezone. Absent while the member is still serving.

createdstring · date-time

When the row was created, in the company's timezone.

updatedstring · date-time

When the row last changed, in the company's timezone.

400 · The calling company is not in HOA business mode.

401 · The bearer token is missing, expired, or not valid.

403 · The token is valid but the caller does not hold the `hoa_board_members:read` permission.

404 · No board seat with that id belongs to the calling company.

HOA companies only

Every architectural request and board member endpoint first checks that the calling company is set up as an HOA. A company in any other business mode gets 400 Bad Request with the detail Company is not in HOA business mode.