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

# Per-object deep search with cursor pagination

> Deep search within a single resource type. Supports per-object filters
and cursor pagination via `starting_after`. Valid objects: orders,
products, accounts, invoices, serial_numbers, quotes, purchase_orders,
returns, vendor_bills, payments, fulfillment_packages.




## OpenAPI

````yaml /openapi.yaml get /search/{object}
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:
  /search/{object}:
    get:
      tags:
        - Search
      summary: Per-object deep search with cursor pagination
      description: |
        Deep search within a single resource type. Supports per-object filters
        and cursor pagination via `starting_after`. Valid objects: orders,
        products, accounts, invoices, serial_numbers, quotes, purchase_orders,
        returns, vendor_bills, payments, fulfillment_packages.
      operationId: searchByObject
      parameters:
        - name: object
          in: path
          required: true
          schema:
            type: string
            enum:
              - orders
              - products
              - accounts
              - invoices
              - serial_numbers
              - quotes
              - purchase_orders
              - returns
              - vendor_bills
              - payments
              - fulfillment_packages
        - name: query
          in: query
          required: false
          schema:
            type: string
            maxLength: 500
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
        - name: starting_after
          in: query
          required: false
          schema:
            type: string
          description: 'Cursor: ID of the last item from the previous page.'
        - name: status
          in: query
          required: false
          schema:
            type: string
          description: Status filter (object-specific).
        - name: from_date
          in: query
          required: false
          schema:
            type: string
            format: date
        - name: to_date
          in: query
          required: false
          schema:
            type: string
            format: date
        - name: account_id
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: account_type
          in: query
          required: false
          schema:
            type: string
            enum:
              - business
              - individual
              - vendor
        - name: category_id
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: location_id
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: Layer 4 location filter for order-type objects.
        - name: expand
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - full
          explode: true
      responses:
        '200':
          description: Cursor-paginated list of matching resources
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                      - list
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SearchBucketItem'
                  has_more:
                    type: boolean
                  next_cursor:
                    type: string
                    nullable: true
                  url:
                    type: string
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '422':
          description: Unknown object type
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                      - unknown_search_object
                  code:
                    type: string
                  hint:
                    type: string
      security:
        - ApiKeyAuth: []
components:
  schemas:
    SearchBucketItem:
      type: object
      description: >
        A single result item from the search API. Returned in both 5-bucket

        (GET /v1/search) and per-object deep (GET /v1/search/{object})
        responses.
      properties:
        id:
          type: string
          format: uuid
        object:
          type: string
          description: Resource type, e.g. order, product, account.
        label:
          type: string
          description: Human-readable primary label (e.g. order number, account name).
        sublabel:
          type: string
          nullable: true
          description: Secondary label (e.g. account name on order, SKU on product).
        snippet:
          type: string
          nullable: true
          description: Short contextual excerpt with match highlight.
        url:
          type: string
          description: Canonical API URL for this resource.
        relevance_score:
          type: number
          nullable: true
          description: >-
            Relative rank score (higher = more relevant). Null on
            exact-match-only queries.
        status:
          type: string
          nullable: true
          description: Current status (object-specific).
        created_at:
          type: string
          format: date-time
        _raw:
          type: object
          nullable: true
          description: Full DB row (only present when expand[]=full requested).
    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.

````