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

# List account addresses across accounts in this entity

> Returns shipping and billing addresses for ALL accounts in the
API key's entity, with optional filters by account, external_source,
or external_id. Stripe-style cursor pagination via `starting_after`.

Use this endpoint when you need to look up addresses that were imported
from an external system (Versa Cloud, Bubble, Shopify, etc.) by their
provenance tuple `(account_id, external_source, external_id)`. Powers
migration back-read paths and integration sync resolvers.

Layer 1 (multi-tenant isolation): the `account_addresses` table has no
`entity_id` column; scope is enforced via JOIN to `accounts.entity_id`.
A crafted cursor pointing at a sister-entity address returns 0 rows
from the inner cursor SELECT, so no row leak.

Filed by the WSS Versa migration agent (P1 blocker for 97,118 NULL
`shipping_address_id` orders/invoices on Phase 2A.7 backfill).
Cross-refs: `docs/prompts/completed/MIGRATION-API-V1-GET-ACCOUNT-ADDRESSES-ENDPOINT [COMPLETE].md`.

Requires `accounts:read` OR `addresses:read` scope.




## OpenAPI

````yaml /openapi.yaml get /account-addresses
openapi: 3.1.0
info:
  title: Arcus ERP Public API
  version: 1.0.0
  description: >
    Arcus ERP public REST API. Designed for external integrations and data
    migration.


    **Authentication.** Bearer token (API key) via the `Authorization` header.

    Format: `Authorization: Bearer ark_live_ent_<code>_<random>` (or
    `ark_test_*` for sandbox).

    API keys are issued per-entity in **Settings > Developers > API Keys**.


    **Entity scoping.** The entity is encoded in the API key prefix; routes are
    flat

    (e.g. `/v1/accounts`, `/v1/orders`, `/v1/products`). A small set of platform
    endpoints

    (migration, reconciliation, events, webhook endpoints, API keys) use the

    `/v1/entities/{entity_id}/...` form -- those are noted in their tags.


    **Key capabilities.**
      - Related-resource hydration via `?expand[]=` (see `x-arcus-expand` on each resource).
      - Cursor-based pagination (`starting_after` / `ending_before` / `limit`).
      - Idempotency via the `Idempotency-Key` header.
      - Webhook events for asynchronous notification.
      - Conditional requests / ETag for cache validation.
servers:
  - url: https://api.arcuserp.com/v1
    description: Arcus ERP API (accepts both live `ark_live_*` and test `ark_test_*` keys)
  - url: https://dev-api.arcuserp.com/v1
    description: >-
      Dev sandbox API (test-only data, accepts `ark_test_*` keys against dev
      RDS)
security: []
paths:
  /account-addresses:
    get:
      tags:
        - Accounts
      summary: List account addresses across accounts in this entity
      description: >
        Returns shipping and billing addresses for ALL accounts in the

        API key's entity, with optional filters by account, external_source,

        or external_id. Stripe-style cursor pagination via `starting_after`.


        Use this endpoint when you need to look up addresses that were imported

        from an external system (Versa Cloud, Bubble, Shopify, etc.) by their

        provenance tuple `(account_id, external_source, external_id)`. Powers

        migration back-read paths and integration sync resolvers.


        Layer 1 (multi-tenant isolation): the `account_addresses` table has no

        `entity_id` column; scope is enforced via JOIN to `accounts.entity_id`.

        A crafted cursor pointing at a sister-entity address returns 0 rows

        from the inner cursor SELECT, so no row leak.


        Filed by the WSS Versa migration agent (P1 blocker for 97,118 NULL

        `shipping_address_id` orders/invoices on Phase 2A.7 backfill).

        Cross-refs:
        `docs/prompts/completed/MIGRATION-API-V1-GET-ACCOUNT-ADDRESSES-ENDPOINT
        [COMPLETE].md`.


        Requires `accounts:read` OR `addresses:read` scope.
      operationId: listAccountAddressesCrossAccount
      parameters:
        - name: account_id
          in: query
          required: false
          description: Filter to addresses belonging to this account.
          schema:
            type: string
            format: uuid
        - name: external_source
          in: query
          required: false
          description: |
            Filter by provenance source label (e.g. `versa_cloud`, `bubble`,
            `shopify`). Migration back-read pattern.
          schema:
            type: string
        - name: external_id
          in: query
          required: false
          description: |
            Filter by the source system's row identifier. Often combined
            with `external_source` for an exact-tuple lookup.
          schema:
            type: string
        - name: limit
          in: query
          required: false
          description: Number of rows to return. Default 25, max 500.
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 25
        - name: starting_after
          in: query
          required: false
          description: |
            Cursor: an address `id` from a previous response. Returns rows
            ordered before this cursor by `(created_at DESC, id DESC)`.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: List of account addresses
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                      - list
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AccountAddress'
                  has_more:
                    type: boolean
                  next_cursor:
                    type: string
                    format: uuid
                    nullable: true
                  url:
                    type: string
                    example: /v1/account-addresses
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
      security:
        - ApiKeyAuth:
            - accounts:read
components:
  schemas:
    AccountAddress:
      type: object
      description: A shipping or billing address for an account.
      properties:
        id:
          type: string
          format: uuid
        account_id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - shipping
            - billing
        label:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
        line1:
          type: string
        line2:
          type: string
          nullable: true
        city:
          type: string
        state:
          type: string
        zip:
          type: string
        country:
          type: string
          default: US
        is_commercial:
          type: boolean
        is_default:
          type: boolean
        is_default_shipping:
          type: boolean
        is_default_billing:
          type: boolean
        is_pickup:
          type: boolean
        is_verified_shippo:
          type: boolean
          readOnly: true
        external_source:
          type: string
          nullable: true
          description: |
            Provenance label for rows imported from external systems
            (e.g. `versa_cloud`, `bubble`, `shopify`). Used with
            `external_id` for migration back-read.
        external_id:
          type: string
          nullable: true
          description: The source system's row identifier for this address.
        created_at:
          type: string
          format: date-time
          readOnly: true
    ErrorEnvelope:
      type: object
      description: |
        Canonical error response envelope. All API errors use this shape.
      required:
        - error
        - code
      properties:
        error:
          type: string
          description: Machine-readable error key
          example: not_found
        code:
          type: string
          description: Machine-readable error code (often same as error)
          example: not_found
        type:
          type: string
          enum:
            - validation_error
            - permission_error
            - not_found
            - conflict
            - rate_limit
            - internal
            - expand_error
            - not_implemented
          example: not_found
        hint:
          type: string
          description: Human-readable one-sentence explanation (English)
          example: >-
            The requested order does not exist or does not belong to this
            entity.
        param:
          type: string
          description: The parameter that caused the error, if applicable
          example: expand[0]
        required:
          type: string
          description: The scope required (only on insufficient_scope errors)
          example: accounts:read
        request_id:
          type: string
          description: >-
            Unique request ID for support tracing (maps to CloudWatch log
            stream)
          example: req_abc123
  responses:
    Error:
      description: Error response (400/401/403/404/409/422/429/500)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: |
        API key issued per entity via Settings > Developers > API Keys.
        Each key carries scopes (e.g. orders:read, products:write).
        Bearer token format: Authorization: Bearer ark_live_ent_<code>_<random>
        Test keys use ark_test_ent_<code>_<random>. Both are issued per entity
        via Settings > Developers > API Keys.

````