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

# List customer accounts

> List active accounts available to the authenticated user. Set includeArchived=true for an organization management list that also includes lifecycle-archived child accounts; archived accounts cannot be selected until restored.



## OpenAPI

````yaml /v2/buyer-api-v2.yaml get /accounts
openapi: 3.0.0
info:
  title: Scope3 Buyer API
  version: 2.0.0
  description: |-
    REST API for advertisers to manage advertisers, campaigns, and reporting.

    ## Authentication

    All endpoints require a Bearer token in the Authorization header:
    ```
    Authorization: Bearer your-api-key
    ```

    ## Base URL

    `https://api.apostra.com/api/v2/buyer`

    ## For AI Agents

    AI agents can use the MCP endpoint at `/mcp/v2/buyer` with three tools:
    - `initialize`: Start an MCP session
    - `api_call`: Make REST API calls
    - `ask_about_capability`: Learn about API features
servers:
  - url: https://api.apostra.com/api/v2/buyer
    description: Production server
security: []
tags:
  - name: Signup
    description: Request reviewed access to Interchange
  - name: Account
    description: Account management, service tokens, and preferences
  - name: Asks
    description: >-
      What you are waiting on Scope3 for — support, product, and supply asks in
      one list
  - name: Advertisers
    description: Manage advertisers
  - name: Product Discovery
    description: Discover and select products
  - name: Campaigns
    description: Manage advertising campaigns
  - name: Creatives
    description: Build, manage, and sync campaign creatives via AdCP Creative Protocol
  - name: Reporting
    description: Access performance metrics
  - name: Event Sources
    description: >-
      Manage event source configurations and log conversion/marketing events for
      attribution
  - name: Property Lists
    description: Validate property lists against AAO registry
  - name: Sales Agents
    description: View and connect sales agents
  - name: Measurement
    description: Measurement sources, records, context, and freshness
  - name: Syndication
    description: Syndicate resources to ADCP agents
  - name: Tasks
    description: Track async operation status
  - name: Buyer Billing
    description: >-
      Consolidated invoicing for buyers — invoices and pending invoice items
      issued by Scope3 across the buyer customer.
  - name: MCP
    description: Model Context Protocol endpoints for AI agents
paths:
  /accounts:
    servers:
      - url: https://api.apostra.com/api/v2
        description: Production server
    get:
      tags:
        - Account
      summary: List customer accounts
      description: >-
        List active accounts available to the authenticated user. Set
        includeArchived=true for an organization management list that also
        includes lifecycle-archived child accounts; archived accounts cannot be
        selected until restored.
      operationId: listCustomerAccounts
      parameters:
        - in: query
          name: includeArchived
          schema:
            description: >-
              Include lifecycle-archived child accounts in the organization
              management list. Archived accounts remain unavailable for account
              switching. A buyer agent's list never includes archived accounts,
              because its grants do not reach them.
            example: false
            default: false
            type: boolean
          description: >-
            Include lifecycle-archived child accounts in the organization
            management list. Archived accounts remain unavailable for account
            switching. A buyer agent's list never includes archived accounts,
            because its grants do not reach them.
      responses:
        '200':
          description: List customer accounts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomerAccountsResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ListCustomerAccountsResponse:
      type: object
      properties:
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/OrgAccountSummary'
          description: >-
            Customer accounts the user has access to. For a buyer agent, the
            active accounts that own advertisers it holds active grants on, plus
            the current account.
      required:
        - accounts
      additionalProperties: false
      description: List of customer accounts for the authenticated user
    ErrorResponse:
      type: object
      properties:
        data:
          type: string
          nullable: true
          enum:
            - null
        error:
          $ref: '#/components/schemas/ApiError'
      required:
        - data
        - error
      additionalProperties: false
      description: Standard error response
    OrgAccountSummary:
      type: object
      properties:
        id:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Customer ID
          example: 100
        company:
          type: string
          description: Company name
          example: Acme Inc
        name:
          type: string
          description: Display name
          example: Acme
        role:
          description: User role on this customer (MEMBER, ADMIN, SUPER_ADMIN)
          example: ADMIN
          type: string
        accountType:
          nullable: true
          description: Buyer or Seller account type. Organization containers are null.
          type: string
          enum:
            - BUYER
            - SELLER
        customerType:
          type: string
          enum:
            - STANDALONE
            - PARENT
            - CHILD
          description: Position in the customer hierarchy.
        parentId:
          nullable: true
          description: Parent organization customer ID for a child account.
          type: integer
          minimum: 0
          exclusiveMinimum: true
          maximum: 9007199254740991
        active:
          type: boolean
          description: Whether this account can be entered and used.
        status:
          type: string
          enum:
            - ACTIVE
            - ARCHIVED
          description: Reversible account lifecycle status.
        archivedAt:
          nullable: true
          description: When this account was most recently archived.
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
        current:
          description: >-
            True for the account the session is acting in. Present when a buyer
            agent lists accounts: its list is the accounts its advertiser grants
            reach plus the current account, and it cannot switch between them.
          type: boolean
      required:
        - id
        - company
        - name
        - accountType
        - customerType
        - parentId
        - active
        - status
        - archivedAt
      additionalProperties: false
      description: Summary of a customer organization account
    ApiError:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code
        message:
          type: string
          description: Human-readable error message
        field:
          description: Field path associated with the error
          type: string
        details:
          description: Additional error context
          type: object
          additionalProperties: {}
      required:
        - code
        - message
      additionalProperties: false
      description: Structured error object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or access token

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.