> ## Documentation Index
> Fetch the complete documentation index at: https://developers.apartmentiq.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List Accounts

> Retrieves a paginated list of ApartmentIQ accounts the authenticated user has access to. Each account object includes its ID and display name.

Use the returned account `id` as the `account_id` parameter when calling other endpoints such as [List Competitive Sets](/api-reference/market-surveys/list-competitive-sets).



## OpenAPI

````yaml /openapi/v1/schema.json get /accounts
openapi: 3.0.3
info:
  title: ApartmentIQ API
  version: 1.14.0
  termsOfService: https://www.getapartmentiq.com/terms
  x-logo:
    url: https://developers.apartmentiq.io/logo.svg
    altText: ApartmentIQ
  description: >-
    ApartmentIQ API providing Accounts, Market Surveys, Markets, Market
    Narratives, and Forecasts endpoints to access accounts, comp sets, market
    survey tables, units, floorplans, and market-based property data. See
    documentation pages for authentication, errors, and rate limits.
servers:
  - url: https://data.apartmentiq.io/apartmentiq/api/v1
security:
  - oauth2: []
tags:
  - name: Accounts
    description: >-
      Endpoints for listing the ApartmentIQ accounts accessible to the
      authenticated user.
  - name: Market Surveys
    description: >-
      Market Survey endpoints can be used to access data related to your market
      surveys within ApartmentIQ. The ApartmentIQ API refers to the list of
      properties within your market surveys as a comp set, or competitive set.
      In the rest of this document, comp set and competitive set will be used
      interchangeably.
  - name: Markets
    description: Endpoints used to access market data.
  - name: Bulk Data Export
    description: >-
      Endpoints for requesting and downloading historical property data through
      asynchronous batch jobs. Submit a job request, monitor its status, and
      download results when ready.
  - name: Forecasts
    description: >-
      Endpoints for retrieving modeled future time-series forecast data for
      geographic boundaries and properties. Forecast data spans from the
      beginning of the current month up to 5 years in the future. Requires
      Explore Pro access.
paths:
  /accounts:
    get:
      tags:
        - Accounts
      summary: List Accounts
      description: >-
        Retrieves a paginated list of ApartmentIQ accounts the authenticated
        user has access to. Each account object includes its ID and display
        name.


        Use the returned account `id` as the `account_id` parameter when calling
        other endpoints such as [List Competitive
        Sets](/api-reference/market-surveys/list-competitive-sets).
      operationId: getAccounts
      parameters:
        - name: page
          in: query
          description: Page number for pagination.
          required: false
          schema:
            type: integer
            default: 1
            minimum: 1
          example: 1
        - name: per_page
          in: query
          description: Number of accounts per page. Maximum value is 100.
          required: false
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 100
          example: 25
      responses:
        '200':
          description: A paginated list of accounts the authenticated user can access.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: Array of account objects.
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: Unique identifier for the account.
                        name:
                          type: string
                          description: Display name of the account.
                      required:
                        - id
                        - name
                  pagination:
                    type: object
                    description: Pagination metadata.
                    properties:
                      current_page:
                        type: integer
                        description: The current page number.
                      total_pages:
                        type: integer
                        description: Total number of pages available.
                      total_count:
                        type: integer
                        description: Total number of accounts across all pages.
                      per_page:
                        type: integer
                        description: Number of accounts per page.
                    required:
                      - current_page
                      - total_pages
                      - total_count
                      - per_page
                required:
                  - data
                  - pagination
              example:
                data:
                  - id: 42
                    name: Acme Properties
                  - id: 87
                    name: Sunrise Communities
                pagination:
                  current_page: 1
                  total_pages: 1
                  total_count: 2
                  per_page: 50
        '401':
          description: Unauthorized - Invalid or missing authentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden - Insufficient permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          description: >-
            An unexpected error occurred while processing the request. Our team
            is investigating.
components:
  schemas:
    Error:
      type: object
      description: >-
        Error response payload. Most errors include error and optional message;
        some validation responses include errors; quota responses include quota
        fields.
      properties:
        error:
          type: string
          description: Short error message
          example: Invalid parameter
        message:
          type: string
          description: Optional detailed message
          example: account_id is required
        errors:
          type: array
          description: Optional list of validation errors.
          items:
            type: string
        quota_limit:
          type: integer
          description: >-
            Quota limit that applied to the request when an account quota was
            exceeded.
        quota_usage:
          type: integer
          description: Current quota usage when an account quota was exceeded.
  responses:
    RateLimitExceeded:
      description: >-
        Rate limit exceeded. Inspect the rate limit headers and wait before
        retrying.
      headers:
        X-RateLimit-Limit:
          description: The limit that applied to the request.
          schema:
            type: string
        X-RateLimit-Reset-After:
          description: The rate limit window length, in seconds.
          schema:
            type: string
        X-RateLimit-Reset:
          description: Unix timestamp when the current window resets.
          schema:
            type: string
        Retry-After:
          description: Seconds to wait before retrying the request.
          schema:
            type: string
      content:
        text/plain:
          schema:
            type: string
          example: |
            You have exceeded the rate limit for this API.
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Trial API quota limit exceeded
            quota_limit: 5000
            quota_usage: 5001
  securitySchemes:
    oauth2:
      type: oauth2
      description: >-
        Enter a Bearer token obtained via the OAuth client credentials flow or
        from the Access Tokens tab in your account settings.
      flows:
        clientCredentials:
          tokenUrl: https://data.apartmentiq.io/oauth/token
          scopes: {}

````