Documentation menu

Organization reference

The caller's organization settings.

GET/organization

Get my organization

Parameters

NameInTypeRequiredDescription
X-Organization-IdheaderstringoptionalTarget organization ObjectId; required for APP_ADMIN and SUPPLIER callers and ignored (must match the caller's own org) for org admins, managers, and users.

Responses

  • 200Your organization.
  • 401Missing/invalid token.
  • 403Authenticated but not allowed (role or cross-org).
  • 404Not found (or not in the caller's org).
PATCH/organization

Update my organization (admin)

Parameters

NameInTypeRequiredDescription
X-Organization-IdheaderstringoptionalTarget organization ObjectId; required for APP_ADMIN and SUPPLIER callers and ignored (must match the caller's own org) for org admins, managers, and users.

Request body OrganizationUpdate (required, application/json)

Responses

  • 200Updated organization.
  • 400Request body/params failed validation.
  • 401Missing/invalid token.
  • 403Authenticated but not allowed (role or cross-org).
  • 404Not found (or not in the caller's org).
  • 429Rate limit exceeded.

OrganizationUpdate schema

FieldTypeRequiredDescription
namestringoptionalThe organization's display name.
locationstringoptionalThe organization's location/address.
logostringoptionalURL of the organization's logo image.