Organization

Get organization profile

Changed on

Retrieve organization profile data used to personalize compliance workflows, Trust Center branding, API automation, and audit readiness reporting.

get/v1/organization

Request

  • Base URL
    https://api.betayum.com
  • URL
    https://api.betayum.com/v1/organization
  • Auth
    API key in header X-API-Key

Query parameters

includeOwnershipstring

Include ownership data for transfer UI

Response

Organization information retrieved successfully

idstring

The organization ID

namestring

Organization name

slugstring

Organization slug

logostring nullable

Organization logo URL

metadatastring nullable

Additional metadata in JSON format

websitestring nullable

Organization website URL

onboardingCompletedboolean

Whether onboarding is completed

hasAccessboolean

Whether organization has access to the platform

fleetDmLabelIdinteger nullable

FleetDM label ID for device management

isFleetSetupCompletedboolean

Whether FleetDM setup is completed

primaryColorstring nullable

Organization primary color in hex format

createdAtstring date-time

When the organization was created

authType'api-key' | 'session'

How the request was authenticated

Example response

{
  "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,
  "primaryColor": "#3B82F6"
}

Changes

  • 946edaa856a9Revision changes
    • warning

      deleted the header request parameter X-Organization-Id

    • info

      added the new optional query request parameter includeOwnership