> ## 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 accounts > Returns a paginated list of accounts for the entity. Filter by `account_type` (business / individual / lead / vendor), `search` (full-text via searchable_text), and `is_active` status. Supports `?expand[]=` for related resources: `data.addresses`, `data.contacts`, `data.payment_methods`, `data.recent_orders`, `data.credit_terms`. Pagination via `page` + `per_page` (max 100). Requires `accounts:read` scope. ## OpenAPI ````yaml /openapi.yaml get /accounts 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__` (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: /accounts: get: tags: - Accounts summary: List accounts description: > Returns a paginated list of accounts for the entity. Filter by `account_type` (business / individual / lead / vendor), `search` (full-text via searchable_text), and `is_active` status. Supports `?expand[]=` for related resources: `data.addresses`, `data.contacts`, `data.payment_methods`, `data.recent_orders`, `data.credit_terms`. Pagination via `page` + `per_page` (max 100). Requires `accounts:read` scope. operationId: listAccounts parameters: - name: account_type in: query schema: type: string enum: - business - individual - lead - vendor - all description: >- Filter by account type. 'customer' is a synthetic alias for business/individual/lead. - name: search in: query schema: type: string description: Full-text search via accounts.searchable_text. - name: is_active in: query schema: type: string enum: - 'true' - 'false' - all description: Filter by active status. Default returns all. - name: include_inactive in: query schema: type: boolean description: Legacy alias for is_active=all. - name: page in: query schema: type: integer default: 1 - name: per_page in: query schema: type: integer default: 25 maximum: 100 - name: expand[] in: query schema: type: array items: type: string enum: - data.addresses - data.contacts - data.payment_methods - data.default_payment_method - data.recent_orders - data.credit_terms style: form explode: true responses: '200': description: Paginated account list content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Account' total: type: integer page: type: integer per_page: type: integer total_pages: type: integer example: data: - id: a1b2c3d4-0001-0001-0001-000000000001 object: account entity_id: ent-uuid-here display_name: Acme Corp company_name: Acme Corporation account_type: business account_number: CUST-00042 email: orders@acme.com phone_main: 212-555-0100 credit_limit: 50000 credit_balance: 12500 is_credit_hold: false tax_exempt: false is_active: true created_at: '2025-01-15T10:00:00Z' updated_at: '2026-04-01T08:30:00Z' total: 1 page: 1 per_page: 25 total_pages: 1 '401': $ref: '#/components/responses/Error' '403': $ref: '#/components/responses/Error' security: - ApiKeyAuth: - accounts:read components: schemas: Account: type: object description: > An Arcus ERP account. Represents a customer, vendor, lead, or individual. account_type drives AR vs AP behavior: business/individual/lead = customer (AR); vendor = supplier (AP). entity_id is always from the API key (Layer 1 isolation). properties: id: type: string format: uuid object: type: string enum: - account entity_id: type: string format: uuid readOnly: true display_name: type: string description: UI-facing name. Required. company_name: type: string nullable: true account_type: type: string enum: - business - individual - lead - vendor description: business/individual/lead = customer (AR); vendor = supplier (AP). account_number: type: string nullable: true readOnly: true description: Auto-generated sequential number within entity. Unique per entity. email: type: string nullable: true phone_main: type: string nullable: true phone_secondary: type: string nullable: true phone_mobile: type: string nullable: true website: type: string nullable: true payment_term_id: type: string format: uuid nullable: true credit_limit: type: number nullable: true credit_balance: type: number readOnly: true description: 'SSOT: utils/ar-helpers.mjs. Do not write directly.' is_credit_hold: type: boolean readOnly: true description: | Read-only on PATCH /accounts/{id} (Rule 23 SSOT). To set or clear the credit hold use the dedicated action endpoint POST /accounts/{id}/credit-hold { on_hold: bool, reason?: string }. The action endpoint delegates to canonical utils/credit-hold-helpers.mjs::setCreditHold which is the SOLE writer and also cascades to orders.is_credit_hold_blocked. tax_exempt: type: boolean avatax_entity_code: type: string nullable: true tax_number: type: string nullable: true default_pricing_level_id: type: string format: uuid nullable: true default_location_id: type: string format: uuid nullable: true default_shipping_method: type: string nullable: true shipping_preference: type: string enum: - always_freight - always_parcel - auto nullable: true enable_pro_portal: type: boolean is_active: type: boolean notes: type: string nullable: true metadata: type: object nullable: true stripe_customer_id: type: string nullable: true readOnly: true source_platform: type: string nullable: true readOnly: true external_customer_id: type: string nullable: true created_at: type: string format: date-time readOnly: true updated_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__ Test keys use ark_test_ent__. Both are issued per entity via Settings > Developers > API Keys. ````