Skip to main content

Get Organization

Get an organization by ID.

Quick Navigation
Outline

Endpoint​

GET /api/v1/organizations/{org_id}

Headers​

HeaderRequiredDescription
AuthorizationYesBearer <access_token>

Path Parameters​

ParameterTypeRequiredDescription
org_idintegerYesUnique identifier of the organization. You can obtain organization IDs from the List Organizations endpoint.

Response​

Success (200)​

{
  "success": true,
  "data": {
    "organization": {
      "id": 1,
      "name": "Acme Corporation",
      "domain": "acme.com",
      "plan": "enterprise",
      "created_at": "2024-01-01T00:00:00Z"
    },
    "message": "Organization retrieved successfully"
  },
  "message": "Organization retrieved successfully"
}

Features​

  • Complete Organization Data: Returns comprehensive organization information including name, domain, plan, and metadata
  • Permission Validation: Ensures only authorized users (organization members or system admins) can access organization details
  • Access Control: Automatically filters organizations based on user membership
  • Metadata Included: Provides creation timestamps and other organizational metadata

Response Fields​

FieldTypeDescription
organizationobjectOrganization details object
organization.idintegerUnique organization identifier
organization.namestringOrganization name
organization.domainstringOrganization domain (if configured)
organization.planstringOrganization subscription plan (e.g., "enterprise", "professional")
organization.created_atstring (ISO 8601)Timestamp when the organization was created

See Also​