Skip to main content
GET
/
api
/
v1
/
orgs
/
{org_id}
Get Org
curl --request GET \
  --url https://api.example.com/api/v1/orgs/{org_id}
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "slug": "<string>",
  "workos_org_id": "<string>",
  "plan": "free",
  "status": "active"
}

Headers

Authorization
string | null

Path Parameters

org_id
string
required

Response

Successful Response

id
string<uuid>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
name
string
required
slug
string
required
workos_org_id
string
required
plan
enum<string>
required
Available options:
free,
pro,
enterprise
status
enum<string>
required
Available options:
active,
suspended,
deleted