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

# Get the property roster

> The canonical property roster: every declared publisher domain with the properties and collections resolved from that publisher's adagents.json, plus the persisted authorization outcome (authorizationStatus and, when resolved under the reason contract, authorizationReason).



## OpenAPI

````yaml /v2/storefront-api-v2.yaml get /property-roster
openapi: 3.0.0
info:
  title: Scope3 Storefront API
  version: 2.0.0
  description: |-
    REST API for partners to manage storefronts, inventory sources, and billing.

    ## Authentication

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

    ## Base URL

    `https://api.interchange.io/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.interchange.io/api/v2/storefront
    description: Production server
security: []
tags:
  - name: Account
    description: Account management, service tokens, and preferences
  - 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 storefronts
  - name: AI Usage
    description: Storefront AI token usage visibility by model
  - name: MCP
    description: Model Context Protocol endpoints
paths:
  /property-roster:
    get:
      tags:
        - Storefront
      summary: Get the property roster
      description: >-
        The canonical property roster: every declared publisher domain with the
        properties and collections resolved from that publisher's adagents.json,
        plus the persisted authorization outcome (authorizationStatus and, when
        resolved under the reason contract, authorizationReason).
      operationId: getStorefrontPropertyRoster
      responses:
        '200':
          description: Get the property roster
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyRosterResponse'
        '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:
    PropertyRosterResponse:
      description: >-
        The storefront property roster: every declared publisher domain with its
        resolved properties, collections, and authorization state.
      type: object
      properties:
        publishers:
          type: array
          items:
            type: object
            properties:
              domain:
                type: string
              provenance:
                type: string
                enum:
                  - declared
                  - crawled
                  - discovered
              adagentsStatus:
                nullable: true
                type: string
                enum:
                  - resolved
                  - no_adagents
                  - error
                  - pending
              authorizationStatus:
                nullable: true
                type: string
                enum:
                  - authorized
                  - unauthorized
                  - unknown
              authorizationReason:
                nullable: true
                type: string
                enum:
                  - no_file
                  - file_invalid
                  - agent_not_listed
                  - agent_untyped
                  - agent_not_property_bound
                  - authorized
              lastSyncedAt:
                nullable: true
                type: string
              properties:
                type: array
                items:
                  type: object
                  properties:
                    propertyKey:
                      type: string
                    propertyId:
                      nullable: true
                      type: string
                    propertyType:
                      nullable: true
                      type: string
                    name:
                      nullable: true
                      type: string
                    identifiers:
                      type: array
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                          value:
                            type: string
                        required:
                          - type
                          - value
                        additionalProperties: false
                    tags:
                      type: array
                      items:
                        type: string
                    provenance:
                      description: >-
                        Origin of the identity record: the publisher-hosted
                        adagents.json, a contributed AAO Registry record
                        awaiting publisher-origin proof, or a property the
                        seller declared conversationally before any
                        publisher-origin declaration exists. Publisher-origin
                        resolution supersedes a seller-declared record with the
                        same property key.
                      type: string
                      enum:
                        - publisher_adagents
                        - aao_registry
                        - seller_declared
                    declaredBySellerAt:
                      nullable: true
                      type: string
                    firstSeenAt:
                      type: string
                    lastSeenAt:
                      type: string
                  required:
                    - propertyKey
                    - propertyId
                    - propertyType
                    - name
                    - identifiers
                    - tags
                    - provenance
                    - declaredBySellerAt
                    - firstSeenAt
                    - lastSeenAt
                  additionalProperties: false
              collections:
                type: array
                items:
                  type: object
                  properties:
                    collectionId:
                      type: string
                    name:
                      nullable: true
                      type: string
                    tags:
                      type: array
                      items:
                        type: string
                    provenance:
                      description: >-
                        Origin of the identity record: the publisher-hosted
                        adagents.json, a contributed AAO Registry record
                        awaiting publisher-origin proof, or a property the
                        seller declared conversationally before any
                        publisher-origin declaration exists. Publisher-origin
                        resolution supersedes a seller-declared record with the
                        same property key.
                      type: string
                      enum:
                        - publisher_adagents
                        - aao_registry
                        - seller_declared
                    firstSeenAt:
                      type: string
                    lastSeenAt:
                      type: string
                  required:
                    - collectionId
                    - name
                    - tags
                    - provenance
                    - firstSeenAt
                    - lastSeenAt
                  additionalProperties: false
            required:
              - domain
              - provenance
              - adagentsStatus
              - authorizationStatus
              - authorizationReason
              - lastSyncedAt
              - properties
              - collections
            additionalProperties: false
        totals:
          type: object
          properties:
            publishers:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            authorizedPublishers:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            properties:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            collections:
              type: integer
              minimum: 0
              maximum: 9007199254740991
          required:
            - publishers
            - authorizedPublishers
            - properties
            - collections
          additionalProperties: false
      required:
        - publishers
        - totals
      additionalProperties: false
    ErrorResponse:
      description: Standard error response
      type: object
      properties:
        data:
          type: string
          nullable: true
          enum:
            - null
        error:
          $ref: '#/components/schemas/ApiError'
      required:
        - data
        - error
      additionalProperties: false
    ApiError:
      description: Structured error object
      type: object
      properties:
        code:
          description: Machine-readable error code
          type: string
        message:
          description: Human-readable error message
          type: string
        field:
          description: Field path associated with the error
          type: string
        details:
          description: Additional error context
          type: object
          additionalProperties: {}
      required:
        - code
        - message
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or access token

````