Get the review summary

Returns three counts for the company's architectural requests — waiting on a manager, out with the board, and overdue. Requires the hoa_architectural_requests: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.

Response

200 · The three counts.

pendingReviewCountinteger

Requests in readyForPmReview, waiting for a manager to approve or deny them.

boardVotingCountinteger

Requests in boardVoting, still out with the board.

overdueCountinteger

Requests whose isOverdue flag is set, in any state. Because the flag is never cleared, this keeps counting requests that were approved or denied after running late.

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_architectural_requests:read` permission.

The three counts overlap

overdueCount is not a subset of either other count. It counts every request with isOverdue set, whatever state it is in now, so a request can be counted twice and an approved request can still be counted as overdue.

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.