> ## 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.

# Preview account archive

> List every live campaign and executable or unsettled media buy that must be resolved before a child account can be archived. Requires administrator authority on the parent organization.



## OpenAPI

````yaml /v2/storefront-api-v2.yaml get /accounts/{customerId}/archive-preview
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:
  /accounts/{customerId}/archive-preview:
    servers:
      - url: https://api.apostra.com/api/v2
        description: Production server
    get:
      tags:
        - Account
      summary: Preview account archive
      description: >-
        List every live campaign and executable or unsettled media buy that must
        be resolved before a child account can be archived. Requires
        administrator authority on the parent organization.
      operationId: previewChildAccountArchive
      parameters:
        - in: path
          name: customerId
          schema:
            type: string
            minLength: 1
            description: Customer ID
            example: '200'
          required: true
          description: Customer ID
      responses:
        '200':
          description: Preview account archive
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountArchivePreviewResponse'
        '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:
    AccountArchivePreviewResponse:
      type: object
      properties:
        account:
          $ref: '#/components/schemas/AccountLifecycle'
        canArchive:
          type: boolean
        reason:
          nullable: true
          type: string
          enum:
            - CURRENT_ACCOUNT
            - ALREADY_ARCHIVED
            - INACTIVE_OTHER
            - DEPENDENCIES
        blockers:
          type: object
          properties:
            campaigns:
              type: array
              items:
                type: object
                properties:
                  campaignId:
                    type: string
                  name:
                    type: string
                  status:
                    nullable: true
                    type: string
                required:
                  - campaignId
                  - name
                  - status
                additionalProperties: false
            mediaBuys:
              type: array
              items:
                type: object
                properties:
                  mediaBuyId:
                    type: string
                  name:
                    type: string
                  status:
                    type: string
                  campaignId:
                    nullable: true
                    type: string
                required:
                  - mediaBuyId
                  - name
                  - status
                  - campaignId
                additionalProperties: false
          required:
            - campaigns
            - mediaBuys
          additionalProperties: false
      required:
        - account
        - canArchive
        - reason
        - blockers
      additionalProperties: false
      description: >-
        Whether a child account can be archived and every campaign or media buy
        that blocks the change.
    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
    AccountLifecycle:
      type: object
      properties:
        id:
          type: integer
          minimum: 0
          exclusiveMinimum: true
          maximum: 9007199254740991
        parentId:
          type: integer
          minimum: 0
          exclusiveMinimum: true
          maximum: 9007199254740991
        status:
          type: string
          enum:
            - ACTIVE
            - ARCHIVED
        active:
          type: boolean
        archivedAt:
          nullable: true
          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))$
        archivedByUserId:
          nullable: true
          type: integer
          minimum: 0
          exclusiveMinimum: true
          maximum: 9007199254740991
        restoredAt:
          nullable: true
          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))$
        restoredByUserId:
          nullable: true
          type: integer
          minimum: 0
          exclusiveMinimum: true
          maximum: 9007199254740991
      required:
        - id
        - parentId
        - status
        - active
        - archivedAt
        - archivedByUserId
        - restoredAt
        - restoredByUserId
      additionalProperties: false
      description: Current reversible lifecycle state for a child 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.