Eos Developers
Design target — not live yet. This documentation defines the contract Eos will implement. Existing internal application APIs are not part of this contract.

Organization API

The Organization API returns the organization permanently bound to the API Client. An API Client cannot select, enumerate, or switch to another organization.

Roles

All active API Client Roles may read the organization summary. Sensitive billing, subscription, license, security, and internal configuration are excluded.

Get the organization

GET /v1/organization

Operation ID: getOrganization

curl https://api.eoshq.com/v1/organization \
  -H 'Authorization: Bearer ACCESS_TOKEN'
{
  "object": "organization",
  "id": "org_01J8Q4VYG8QF9MR6X2F3XVBJPQ",
  "name": "Acme Services",
  "status": "active",
  "timezone": "America/Chicago",
  "currency": "USD",
  "locale": "en-US",
  "created_at": "2025-11-03T14:20:00Z",
  "links": {
    "web": "https://app.eoshq.com/settings"
  }
}

Response fields

Field Type Description
id string Stable opaque organization ID
name string Display name
status enum active, restricted, or suspended
timezone string IANA time-zone identifier
currency string ISO 4217 default currency
locale string BCP 47 locale
created_at timestamp Organization creation time
links.web URI Named-user Eos interface; not an API endpoint

Not supported

The v1 API does not permit API Clients to update organization settings, billing, licenses, ownership, plans, security, or integration policy.

Next: Members API.