Skip to main content
GET
Get Company Metadata

Authorizations

Authorization
string
header
required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Path Parameters

companyId
string<uuid>
required

Company identifier

Response

The company's identity metadata.

A company's small, stable identity metadata. shortName is the environment-stable, uniquely-indexed company identifier (it does not change between staging and production); id is the per-environment UUID.

id
string<uuid>
required

The company's UUID (per-environment).

name
string
required

The company's human-readable display name.

shortName
string
required

The company's stable, uniquely-indexed short name (e.g. compscience) — the same value used in the GCS object-key convention. Stable across environments, unlike id.