Skip to main content
GET
List products

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

limit
integer
default:25

Maximum number of records to return per page. Default 25, max 500. Use together with starting_after for cursor pagination. For larger bulk extraction workflows prefer the migration endpoints.

Required range: 1 <= x <= 500
starting_after
string

Cursor for pagination. Pass the id of the last record from the previous page to fetch the next page. Mutually exclusive with ending_before.

Maximum string length: 200
ending_before
string

Cursor for reverse pagination. Pass the id of the first record from the previous page to fetch the prior page. Mutually exclusive with starting_after.

Maximum string length: 200
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}$
fields
string

Sparse fieldset selector. Comma-separated list of top-level fields to include in the response. When omitted, the full default response is returned. The id field is always included. Example: fields=id,name,email

Maximum string length: 1000
type
enum<string>
Available options:
physical,
kit,
box,
service,
variant_parent
is_active
boolean
sellable
boolean

When true, exclude products marked component-only (is_sellable=false). Omit for no sellability filter.

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