Get Organization

Get organization details by ID

Authentication

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

OR
AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

Path parameters

org_idstringRequiredformat: "uuid"
The organization ID

Response

Organization details retrieved successfully
namestring
contact_emailstringformat: "email"
idstringformat: "uuid"
avatar_urlstring or nullOptional
public_metadatamap from strings to stringsOptionalDefaults to {}
low_credit_alertsbooleanOptionalDefaults to false
usage_based_pricing_enabledbooleanOptionalDefaults to false
planenumOptional
plan_statusenumOptional
plan_intervalenum or nullOptional
pending_planenum or nullOptional
pending_plan_intervalenum or nullOptional
pending_plan_datedatetime or nullOptional
trial_ends_atdatetime or nullOptional
grace_period_ends_atdatetime or nullOptional
auto_topup_configmap from strings to anyOptionalDefaults to {}
accountobject or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error