Architectural requests

List architectural requests

Returns a page of the company's architectural requests, newest first, filtered by status, property, or overdue state. Requires the hoa_architectural_requests:read permission.

GET
https://services.magicdoor.com/hoa/company-portal/associations/architectural-requests

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.

Query parameters

currentPageinteger

Which page to return. Counting starts at 1, and anything below 1 is treated as 1.

default: 1example: 1
pageSizeinteger

How many requests to return per page. A value below 1 falls back to 50.

default: 20example: 20
statusesenum<string>[]

Return only requests in these states. Repeat the parameter once per value, for example statuses=boardVoting&statuses=readyForPmReview. Omit it to get every state.

draftboardVotingreadyForPmReviewapproveddeniedcancelled
propertyIdsstring[]

Return only requests on these properties. Repeat the parameter once per property.

isOverdueboolean

true returns only requests whose voting deadline passed before the board finished; false returns only those that did not. Omit it to get both.

Response

200 · A page of architectural requests.

currentPageinteger

The page you asked for.

pageSizeinteger

How many requests a full page holds.

totalCountinteger

How many requests match the filter across every page.

itemsobject[]

The requests on this page, newest first.

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.

An architectural request is an owner's ask for permission to change something on their property — a fence, a colour, an extension. It moves through a fixed set of states, and the endpoints in this section are only legal from some of them.

StatusWhat it means
draftCreated but not yet sent to the board. Files can be added and removed only here.
boardVotingA board vote is open. Board members are voting yes or no.
readyForPmReviewWaiting for a manager's decision. A request lands here when the board finishes voting, when the deadline passes, or when a manager forces it.
approvedA manager approved it. Final.
deniedA manager denied it. Final.
cancelledCancelled before any decision was made. Final.
How a draft reaches the board

The company portal has no endpoint that submits a draft for voting. A request created here stays in draft until the owner it was filed for submits it from the owner portal.

Two fields only the single-request read fills in

submittedByOwnerName and boardRequestProgress are never returned here. Fetch one request by id when you need the submitter's name or the live vote tallies.

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.