MagicDoorAPI
SupportOpen MagicDoor
Connected accounts

List connected accounts

Returns a page of the company's connected accounts, newest first. A connected account is the link between one of the company's bank accounts and the payment processor MagicDoor runs, and it is what lets money settle to that bank account. Accounts held with any other processor are not returned. Requires the connected_accounts:read permission.

GET
https://services.magicdoor.com/payments/company-portal/accounts

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

pageinteger

Which page to return. The first page is 1.

default: 1
pageSizeinteger

How many items to return per page. Between 1 and 100.

default: 50
idsstring[]

Return only these connected accounts. Repeat the parameter once per id. Sending the parameter with no value is rejected.

bankAccountIdsstring[]

Return only the connected accounts that settle to these company bank accounts. Repeat the parameter once per id. Sending the parameter with no value is rejected.

statusesenum<string>[]

Return only accounts in these states. Repeat the parameter once per value. Sending the parameter with no value is rejected.

requestedpendingunderReviewapprovedactivatedrejectedsuspendedexceptiondenied

Response

200 · A page of connected accounts.

itemsConnectedAccount[]required

This page of results, newest first.

totalCountintegerrequired

How many items match the filter across every page.

totalPagesintegerrequired

How many pages the result set has at this page size.

pageintegerrequired

The page that was returned.

pageSizeintegerrequired

How many items were asked for per page.

401 · The request carried no valid access token.

403 · The token is not a property manager token, or it lacks the `connected_accounts:read` permission.