Tenants

A tenant is a unique organization that has its own set of users and data. Each tenant is isolated from other tenants, ensuring that data and resources are kept separate.

Users are unable to create or delete tenants.

Tenant object

{
  "id": "01988ba3-cca3-7b10-be2d-90703437e4dd",
  "owner": "0198080b-cb61-7e1d-98c3-83f2u44894f2",
  "domain": "example-organization",
  "name": "Example Organization",
  "meta": {
    "brand_color_background": "#57a8d6",
    "brand_color_foreground": "#ffffff",
    "brand_logo": "logo-example-organization.png",
    "currency_code": "USD",
    "dates_date_opened": "2025-08-08",
    "dates_fiscal_year_start_day": 1,
    "dates_fiscal_year_start_month": 1
  },
  "enabled": true,
  "created_at": "2025-08-08 21:43:44",
  "updated_at": "2025-11-08 08:18:37"
}

Fields

• tenant
  required readonly string
  Unique ID of the tenant.
• owner
  required string
  Unique ID of the owner. This can only be updated by the current owner.
• domain
  required readonly string
  Unique URL-friendly domain of the tenant.
• name
  required string
  Name of the tenant.
• meta
  nullable object
  Additional metadata about the tenant. The following keys are used by Bloom's web app:

  • brand_color_background (required): Hexadecimal color code for the tenant's background color.
  • brand_color_foreground (required): Hexadecimal color code for the tenant's foreground color.
  • brand_logo: File name of the tenant's logo.
  • currency_code (required): ISO 4217 currency code for the tenant's currency.
  • dates_date_opened (required): Date the tenant was opened in YYYY-MM-DD format.
  • dates_date_accredited: Date the tenant was accredited in YYYY-MM-DD format.
  • dates_fiscal_year_start_day (required): Day of the month the tenant's fiscal year starts (1-31).
  • dates_fiscal_year_start_month (required): Month the tenant's fiscal year starts (1-12).
• enabled
  required readonly boolean
  Whether the tenant is enabled or disabled.
• created_at
  required readonly string
  UTC timestamp of when the record was created.
• updated_at
  nullable readonly string
  UTC timestamp of when the record was last updated.

List tenants

GET /tenants

Required permissions

Users can only read tenants they own or belong to.

Response

Read a tenant

GET /tenants/{id}/

Required permissions

Users can only read tenants they own or belong to.

Response

Update a tenant

PATCH /tenants/{id}

The request body must include parts of a tenant object.

Required permissions

tenant:update

Response

Read a tenant's subscription

A tenant's subscription contains information about the tenant's allowed features, number of locations, and storage.

GET /tenants/{id}/subscription

Required permissions

Users can only read tenant subscriptions to tenants they own or belong to.

Response

Tenant subscription object

{
  "tenant": "01988bb8-1cfb-7c87-9326-93op0349288e",
  "features": [
    "activities",
    "attendance",
    "bookmarks",
    "communication",
    "contacts",
    "earnings",
    "file_shares",
    "files",
    "folders",
    "goal_progress",
    "goals",
    "locations",
    "member_applications",
    "members",
    "notifications",
    "options",
    "positions",
    "revenues",
    "staff",
    "tenant_invitations",
    "tenant_roles",
    "tenant_user_meta",
    "tracking"
  ],
  "locations": 2,
  "storage": {
    "bytes_allowed": 2000000000,
    "bytes_used": 1909578
  }
}

Fields

• tenant
  required readonly string
  Unique ID of the tenant.
• features
  required readonly array
  List of features enabled for the tenant.
• locations
  required readonly integer
  Number of locations allowed for the tenant.
• storage.bytes_allowed
  required readonly integer
  Number of bytes allowed for the tenant's file storage.
• storage.bytes_used
  required readonly integer
  Number of bytes used by the tenant's file storage.