Tenant permissions

Tenant permissions are assigned by Bloom depending on the tenant's subscription plan.

Tenant permission object

By requesting the permission-related fields, the entire permission object will be returned.

Example including the related permission object:

{
  "id": "01988bb8-1e13-72cc-9813-832338501jdn",
  "tenant": "01988bb8-1cfb-7c87-9326-93op0349288e",
  "permission": {
    "id": "019429e0-6bd4-7da7-ab8d-83f22dcbc3f2",
    "name": "activities:create",
    "description": "Create activities",
    "created_at": "2025-01-03 01:56:01",
    "updated_at": "2025-03-07 02:38:35"
  },
  "created_at": "2025-08-08 22:05:56",
  "updated_at": null
}

Fields

• id
  required readonly string
  Unique ID of the record.
• tenant
  required readonly string
  Unique ID of the tenant.
• permission.id
  required readonly string
  Unique ID of the permission record.
• permission.name
  required readonly string
  Unique name of the permission.
• permission.description
  nullable readonly string
  Description of the permission.
• permission.created_at
  readonly string
  UTC timestamp of when the permission was created.
• permission.updated_at
  nullable readonly string
  UTC timestamp of when the permission was last updated.
• 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 tenant permissions

GET /tenants/{tenantId}/permissions

Required permissions

tenant_permissions:read

Response

Read a tenant permission

GET /tenants/{tenantId}/permissions/{id}

Required permissions

tenant_permissions:read

Response