Sign in
organizations

Changed on

A viewset for managing organizations.

get/organizations/{id}{format}

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid

Path parameters

format'.json' required
idstring required

Headers

X-Organization-Idstring

Selects the active organization for this request. Optional for callers that belong to exactly one active organization — the single membership is resolved implicitly. Required when the caller has two or more active memberships; omitting it in that case returns 400. If the header names an organization the caller is not an active member of, the server returns 403.

Response

idinteger required
namestring required
slugstring

Public, URL-safe identifier used by the organization's branded login page and by brandingForTenant. Always set: an organization saved without one is given an opaque org-<token> slug, and the database refuses a blank value. Mutable, but not clearable -- changing it orphans previously-issued branded login URLs, which then fall back to the default identity rather than erroring. Format, reserved-word, and confusable-character rules live in organizations.slug_validation and are enforced by each write surface (REST serializer, admin form, GraphQL input), not on the model.

should_sync_roomsboolean

Whether to sync rooms for this organization.

external_event_update_policy'allow' | 'change_request' | 'forbidden'
  • allow - Allow direct updates
  • change_request - Updates create change requests
  • forbidden - Updates are forbidden
week_start'monday' | 'sunday'
  • monday - Monday
  • sunday - Sunday
google_service_accountobject nullable required

Return read-only service account info (no secrets), or None if unconfigured.

can_invite_organizationsboolean required

Whether this organization can invite/create other organizations. DB/Django-admin only — never exposed via any API. Enables the whole reseller capability bundle.

createdstring date-time required
modifiedstring date-time required

Changes