Skip to main content
GET
Get Organization

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Successful Response

Response model for organization endpoints.

SECURITY: Does NOT expose internal_id to prevent leakage of high-entropy secrets. Only organization_id (public identifier) is included in API responses.

organization_id
string
required
organization_name
string
required
account_type
enum<string>
required

Account tier (2026-07 pricing overhaul).

Current tiers (CC-required, tier minimum is a billing floor): BUILD: $25/mo min — 100K objects/mo (managed) / 1M vectors (MVS) SCALE: $250/mo min — 1M objects/mo (managed) / 25M vectors (MVS) ENTERPRISE: Custom — dedicated compute, SLA

LEGACY tiers — still stored on unmigrated orgs; resolvable until the Phase-4 migration completes (do NOT remove before then — org records in Mongo carry these strings): FREE (→ Build or read-only), PRO (→ Build), TEAM (→ Scale)

Available options:
build,
scale,
enterprise,
free,
pro,
team
credit_count
integer
required
rate_limits
BaseRateLimits · object
required

Rate limits by operation type (requests per minute).

The rate limiting system uses 5 categories aligned with actual resource consumption:

Categories: metadata: Infrastructure and configuration operations (namespaces, collections, retrievers, taxonomies, clusters CRUD). Zero-credit operations with highest rate limits.

Rate Limit Strategy: Higher limits for low-cost operations (metadata, data) Lower limits for high-cost operations (upload, compute) This aligns API throttling with actual infrastructure costs

Examples: - Creating a namespace: Uses 'metadata' category (fast, cheap) - Uploading a file: Uses 'upload' category (slow, expensive per MB) - Executing a retriever: Uses 'search' category (moderate cost) - Running batch processing: Uses 'compute' category (very expensive)

created_at
string<date-time>
required
updated_at
string<date-time>
required
logo_url
string | null
effective_monthly_credit_cap
integer | null
onboarding_answers
Onboarding Answers · object | null
metadata
Metadata · object
billing_email
string<email> | null
notifications_email
string<email> | null
auto_billing_enabled
boolean
default:false
billing_cycle_start
integer
default:1
current_month_usage
integer
default:0
users
Users · object[] | null
auth_provider_org_id
string | null
default_llm_credentials
Default Llm Credentials · object
api_url
string | null
requires_plan
boolean
default:false

True when this workspace must pick a plan before it can create namespaces or run billable work. When gated, write endpoints return 403 PlanRequiredError with a link to https://studio.mixpeek.com/signup/plan.