Skip to main content
GET
/
products
List products
curl --request GET \
  --url https://api.arcuserp.com/v1/products \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "prod-uuid-0001",
      "object": "product",
      "entity_id": "ent-uuid-here",
      "title": "Widget Pro XL",
      "sku": "WDG-PRO-XL",
      "part_number": "WP-001",
      "barcode": "012345678901",
      "product_type": "physical",
      "list_price": 49.99,
      "cost": 18.5,
      "is_active": true,
      "is_serialized": false,
      "charge_tax": true,
      "track_inventory": true,
      "weight": 1.2,
      "weight_uom": "lb",
      "quantity_uom": "each",
      "created_at": "2025-06-01T12:00:00Z",
      "updated_at": "2026-03-15T09:00:00Z"
    }
  ],
  "has_more": false,
  "url": "/v1/products"
}

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.

Authorizations

​
Authorization
string
header
required

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.

Query Parameters

​
expand
string[]

Related-resource hydration. Provide one or more paths to expand; nested via dot syntax (e.g. expand[]=line_items.product).

Rules:

  • Max depth: 4
  • Max paths per request: 10
  • List endpoints REQUIRE the "data." prefix on every path (e.g. GET /v1/orders uses expand[]=data.customer, not expand[]=customer)
  • Per-relation hydrated count cap: 100 rows. Exceeding rows return reference IDs only with truncated: true.
  • Per-path scope assertion: each path requires the corresponding :read scope on the API key. e.g. expanding "customer" on an order requires accounts:read.

Valid expand paths per resource are documented in x-arcus-expand extensions on individual endpoint operations.

Maximum array length: 10
Maximum string length: 100
Pattern: ^[a-zA-Z_][a-zA-Z0-9_.]{0,99}$
​
search
string
​
type
enum<string>
Available options:
physical,
kit,
box,
service,
variant_parent
​
is_active
boolean
​
category_id
string<uuid>
​
vendor_id
string<uuid>

Response

Paginated product list

​
object
enum<string>
Available options:
list
​
data
object[]
​
has_more
boolean
​
url
string