Get organization information

Returns detailed information about the authenticated organization. Supports both API key authentication (X-API-Key header) and session authentication (cookies + X-Organization-Id header).

GET /v1/organization

Get organization information

cURL

curl --request GET \
  --url http://localhost:3333/v1/organization \
  --header 'X-API-Key: <api-key>'

200

{
  "id": "org_abc123def456",
  "name": "Acme Corporation",
  "slug": "acme-corp",
  "logo": "https://example.com/logo.png",
  "metadata": "{\"theme\": \"dark\", \"preferences\": {}}",
  "website": "https://acme-corp.com",
  "onboardingCompleted": true,
  "hasAccess": true,
  "fleetDmLabelId": 123,
  "isFleetSetupCompleted": false,
  "primaryColor": "#3B82F6",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Headers

X-Organization-Id · string

Organization ID (required for session auth, optional for API key auth)

Response

200

application/json

Organization information retrieved successfully

id · string

The organization ID

Example:

"org_abc123def456"

name · string

Organization name

Example:

"Acme Corporation"

slug · string

Organization slug

Example:

"acme-corp"

logo · string | null

Organization logo URL

Example:

"https://example.com/logo.png"

metadata · string | null

Additional metadata in JSON format

Example:

"{\"theme\": \"dark\", \"preferences\": {}}"

website · string | null

Organization website URL

Example:

"https://acme-corp.com"

onboardingCompleted · boolean

Whether onboarding is completed

Example:

true

hasAccess · boolean

Whether organization has access to the platform

Example:

true

fleetDmLabelId · integer | null

FleetDM label ID for device management

Example:

123

isFleetSetupCompleted · boolean

Whether FleetDM setup is completed

Example:

false

primaryColor · string | null

Organization primary color in hex format

Example:

"#3B82F6"

createdAt · string<date-time>

When the organization was created

authType · enum<string>

How the request was authenticated

Available options: api-key, session