Skip to main content
GET
Retrieve entity metadata and settings

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.

Path Parameters

id
string<uuid>
required

Entity UUID (must match the API key entity).

Response

Entity metadata + settings.

object
enum<string>
Available options:
entity
id
string<uuid>
code
string
name
string
is_active
boolean
environment
string
settings
object
default_location_id
string<uuid> | null
default_location_name
string | null
logo_url
string | null
icon_url
string | null
created_at
string<date-time>
updated_at
string<date-time>
locations
object[]