Get organization details by external Id
Retrieves organization details by external ID, including name, region, metadata, and settings. Only provide external_id in the path. If the id query parameter is also supplied, it silently takes precedence over external_id due to protobuf oneof semantics, which causes the request to fail with a 400 Bad Request ('ExternalId is required').
Path parameters
Unique identifier that links an organization to your app's tenant. Use this with the GetOrganizationByExternalId endpoint. Only one of id or external_id should be provided per request.
Query parameters
Unique Scalekit-generated identifier for an organization. Use this with the GetOrganization endpoint. Do not pass this parameter when calling GetOrganizationByExternalId — use external_id instead.
Response
Returns the complete organization object with ID, display name, settings, external ID and metadata
Example response
{
"organization": {
"create_time": "2025-02-15T06:23:44.560000Z",
"display_name": "Megasoft",
"external_id": "my_unique_id",
"id": "org_59615193906282635",
"logo_url": "https://cdn.example.com/acme-logo.png",
"settings": {
"features": [
{
"enabled": true,
"name": "sso"
},
{
"enabled": false,
"name": "directory_sync"
}
]
},
"slug": "acme",
"update_time": "2025-02-15T06:23:44.560000Z"
}
}