> ## 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 inbound email addresses

> List the email addresses this account receives mail at, newest first, each at its latest revision. Pass `status=all` to include revoked addresses. Admin-only.



## OpenAPI

````yaml /v2/storefront-api-v2.yaml get /inbound-email-addresses
openapi: 3.0.0
info:
  title: Scope3 Storefront API
  version: 2.0.0
  description: >-
    REST API for partners to manage Seller Accounts, inventory sources, and
    billing.


    ## Authentication


    All endpoints require a Bearer token in the Authorization header:

    ```

    Authorization: Bearer your-api-key

    ```


    ## Base URL


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


    ## For AI Agents


    AI agents can use the MCP endpoint at `/mcp/v2/storefront` 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/storefront
    description: Production server
security: []
tags:
  - 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: Storefront
    description: Manage storefront and inventory sources
  - name: Storefront Agents
    description: List and manage registered sales, signals, and outcomes agents
  - name: Storefront Activity
    description: Audit log of configuration and inventory changes on the storefront
  - name: Storefront Billing
    description: Payout bank details and billing configuration for Seller Accounts
  - name: AI Usage
    description: Seller Account AI token usage visibility by model
  - name: MCP
    description: Model Context Protocol endpoints
paths:
  /inbound-email-addresses:
    servers:
      - url: https://api.apostra.com/api/v2
        description: Production server
    get:
      tags:
        - Account
      summary: List inbound email addresses
      description: >-
        List the email addresses this account receives mail at, newest first,
        each at its latest revision. Pass `status=all` to include revoked
        addresses. Admin-only.
      operationId: listInboundEmailAddresses
      parameters:
        - in: query
          name: status
          schema:
            default: active
            description: >-
              `active` (default) lists only addresses that currently receive
              mail; `all` also lists revoked addresses.
            type: string
            enum:
              - active
              - all
          description: >-
            `active` (default) lists only addresses that currently receive mail;
            `all` also lists revoked addresses.
        - in: query
          name: take
          schema:
            default: 100
            description: Maximum number of addresses to return (1-500, default 100)
            type: integer
            minimum: 1
            maximum: 500
          description: Maximum number of addresses to return (1-500, default 100)
        - in: query
          name: skip
          schema:
            default: 0
            description: Number of addresses to skip, for paging
            type: integer
            minimum: 0
            maximum: 9007199254740991
          description: Number of addresses to skip, for paging
      responses:
        '200':
          description: List inbound email addresses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundEmailAddressesResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Admin role required.
          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:
    InboundEmailAddressesResponse:
      type: object
      properties:
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/InboundEmailAddress'
          description: >-
            One page of the account’s inbound email addresses, newest first.
            Each address appears once, at its latest revision.
        total:
          type: integer
          minimum: 0
          maximum: 9007199254740991
          description: Number of addresses matching the status filter
      required:
        - addresses
        - total
      additionalProperties: false
    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
    InboundEmailAddress:
      type: object
      properties:
        id:
          type: string
          format: uuid
          pattern: >-
            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
          description: Stable address ID. It stays the same when the address is rotated.
        address:
          type: string
          format: email
          pattern: >-
            ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
          description: >-
            The email address to send to: a readable prefix, an unguessable
            suffix and the dedicated inbound domain.
          example: coke-reports-k7m2qz4xhd9a@in.staging.apostra.com
        purpose:
          type: string
          enum:
            - briefs
            - reports
          description: >-
            What the address is for. `briefs` receives briefs and requests;
            `reports` receives reports. The purpose is part of the readable
            address prefix and selects the handler.
          example: reports
        handler:
          type: string
          enum:
            - session_intake
          description: >-
            Where received mail is delivered. `session_intake` records each
            message privately in the account’s shared Session.
        customerId:
          type: integer
          minimum: 0
          exclusiveMinimum: true
          maximum: 9007199254740991
          description: Customer account that owns this address
        advertiserId:
          nullable: true
          description: >-
            The advertiser this address belongs to, or null for an account-wide
            address
          type: integer
          minimum: 0
          exclusiveMinimum: true
          maximum: 9007199254740991
        revision:
          type: integer
          minimum: 0
          exclusiveMinimum: true
          maximum: 9007199254740991
          description: Increases by one each time the address is rotated
        status:
          type: string
          enum:
            - active
            - revoked
          description: >-
            `active` addresses receive mail. Mail to a `revoked` or rotated-away
            address is refused.
        createdAt:
          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))$
          description: When this revision of the address was created
        revokedAt:
          nullable: true
          description: When the address stopped receiving, or null while active
          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))$
      required:
        - id
        - address
        - purpose
        - handler
        - customerId
        - advertiserId
        - revision
        - status
        - createdAt
        - revokedAt
      additionalProperties: false
    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.