Skip to main content
GET
Read company health

Authorizations

Authorization
string
header
required

A company admin credential for your company. Droplet installation tokens are refused.

Query Parameters

areas[]
enum<string>[]

Only these areas. Omit for every area you can see.

An area key.

Available options:
droplets,
connect,
payments,
checkout,
tax,
shipping,
fulfillment,
subscriptions,
mist_apps,
themes,
auth,
fairshare

Response

The company's health.

company_health
object
required
status
integer
required
meta
object
required

Response metadata included on every response body. A refused droplet installation token's 403 names the request request_id rather than request_uuid.