Skip to content
Last updated

The Organization object represents a workspace or company entity in the Freddy system. Organizations serve as the primary container for users, resources, AI configurations, and billing.

Properties

Identity

id string required

Unique organization identifier. Format: org_ followed by 32 hexadecimal characters.

name string required

Organization display name (1-255 characters).

type string required

Organization type. One of: Work, Personal, School.

description string | null optional

Organization description.

website string | null optional

Organization website URL (max 500 characters).

industry string | null optional

Industry classification (max 100 characters).

company_size string | null optional

Company size range (max 50 characters).

Branding

logo_image string | null optional

Base64-encoded organization logo image. Automatically resized to 512x512 and compressed to ~200KB.

image_url string | null optional

Public URL to the organization's logo image.

Status & Configuration

is_active boolean required

Whether the organization is active and can be used. Default: true.

owner_id string | null optional

User ID of the organization owner.

Resource Limits

api_usage_limit float required

API usage spending limit in CHF. Default: 0.0 (no limit).

total_usage_limit float required

Total usage spending limit in CHF. Default: 0.0 (no limit).

storage_free_bytes_allowance integer required

Free storage allowance in bytes. Default: 52428800 (50MB).

api_key_usage_limit float | null optional

Monthly spending limit for all API keys combined (CHF).

Pricing

pricing_tier_id string | null optional

Reference to the organization's pricing tier. Default: tier_standard.

Domain Management

users_added_from_domains integer | null optional

Number of users automatically added based on email domains.

Timestamps

created_at string required

Timestamp when the organization was created. Format: ISO 8601 datetime string.

updated_at string required

Timestamp when the organization was last updated. Format: ISO 8601 datetime string.

Relationships

Organizations have the following related entities: