Get entitlements for an organization
get
/v1/organizations/{slug}/entitlementsReturns the entitlements available to the organization based on their plan and any overrides.
OAuth scopes
- organizations:read
The fine-grained token must include the following permissions to access this endpoint:
- organization_admin_read
Path parameters
- slugRequiredstring
Organization slug
Response codes
- 200
- 401
- 403
- 429
Response (200)
{ "entitlements": [ { "feature": { "key": "instances.compute_update_available_sizes", "type": "boolean" }, "hasAccess": true, "type": "boolean", "config": { "enabled": true } } ]}{ "type": "object", "properties": { "entitlements": { "type": "array", "items": { "type": "object", "properties": { "feature": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "instances.compute_update_available_sizes", "instances.read_replicas", "instances.disk_modifications", "instances.high_availability", "instances.orioledb", "replication.etl", "storage.max_file_size", "storage.max_file_size.configurable", "storage.image_transformations", "storage.vector_buckets", "storage.iceberg_catalog", "storage.purge_cache", "security.audit_logs_days", "security.questionnaire", "security.soc2_report", "security.iso27001_certificate", "security.private_link", "security.enforce_mfa", "log.retention_days", "custom_domain", "vanity_subdomain", "ipv4", "pitr.available_variants", "log_drains", "audit_log_drains", "branching_limit", "branching_persistent", "auth.mfa_phone", "auth.mfa_web_authn", "auth.mfa_enhanced_security", "auth.hooks", "auth.platform.sso", "auth.custom_jwt_template", "auth.saml_2", "auth.user_sessions", "auth.leaked_password_protection", "auth.advanced_auth_settings", "auth.performance_settings", "auth.password_hibp", "auth.custom_oauth.max_providers", "backup.retention_days", "backup.restore_to_new_project", "backup.schedule", "function.max_count", "function.size_limit_mb", "realtime.max_concurrent_users", "realtime.max_events_per_second", "realtime.max_joins_per_second", "realtime.max_channels_per_client", "realtime.max_bytes_per_second", "realtime.max_presence_events_per_second", "realtime.max_payload_size_in_kb", "project_scoped_roles", "security.member_roles", "project_pausing", "project_cloning", "project_restore_after_expiry", "assistant.advance_model", "integrations.github_connections", "integrations.github_push_webhooks_limit", "dedicated_pooler", "observability.dashboard_advanced_metrics", "api.members.invitations", "api.members.roles" ] }, "type": { "type": "string", "enum": [ "boolean", "numeric", "set" ] } }, "required": [ "key", "type" ] }, "hasAccess": { "type": "boolean" }, "type": { "type": "string", "enum": [ "boolean", "numeric", "set" ] }, "config": { "anyOf": [ { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] }, { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" }, "unlimited": { "type": "boolean" }, "unit": { "type": "string" } }, "required": [ "enabled", "value", "unlimited", "unit" ] }, { "type": "object", "properties": { "enabled": { "type": "boolean" }, "set": { "type": "array", "items": { "type": "string" } } }, "required": [ "enabled", "set" ] } ] } }, "required": [ "feature", "hasAccess", "type", "config" ] } } }, "required": [ "entitlements" ]}