Skip to main content
GET
/
accounts
List Accounts
curl --request GET \
  --url https://data.apartmentiq.io/apartmentiq/api/v2/accounts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "{account_id}",
      "name": "Northstar Residential"
    },
    {
      "id": "{account_id}",
      "name": "Lakeview Multifamily Fund"
    },
    {
      "id": "{account_id}",
      "name": "Crescent Urban Living"
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 3,
    "per_page": 50
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
default:1

Page number. Values less than 1 are treated as 1.

Required range: x >= 1
​
per_page
integer
default:50

Rows per page. Values above 100 are capped at 100.

Required range: 1 <= x <= 100

Response

Accessible accounts and pagination metadata.

Paginated list of accounts available to the authenticated user.

​
data
object[]
required

Accounts available to the authenticated user.

​
pagination
object
required

Pagination details for the account list.