Get the organization
⚠️
Preview — this feature is being built; the design below is the spec.
GET https://app.syntic.ai/v1/organizations/meReturn the organization the admin key belongs to: name, plan, credit settings, rate-limit tier and API-relevant settings. A good first call in any admin script, to confirm the key points where you expect.
For how this fits into a full workflow, see Organization info.
Headers
| Header | Required | Value |
|---|---|---|
Authorization | Yes | Bearer <admin key>: an Admin API key (sk_admin_...). Inference keys are refused with 403 admin_key_required. See Admin API keys. |
syntic-beta | Yes, while in preview | admin-2026-11-01. Without it the call fails with 400 beta_required. See Versioning. |
Response
200 OK, Content-Type: application/json
{
"id": "org_01J9Z1B3D5F7H9K1M3P5",
"type": "organization",
"name": "Acme Store",
"plan": {
"name": "Business",
"status": "active",
"current_period_end": "2026-12-01T00:00:00Z",
"monthly_token_allowance": 2000000
},
"usage_credits": {
"enabled": true,
"balance_usd": "184.2200",
"monthly_spend_limit_usd": "500.00",
"auto_reload": {
"enabled": true,
"trigger_usd": "20.00",
"target_usd": "100.00"
}
},
"rate_limit_tier": "2",
"settings": {
"zero_data_retention": false,
"data_retention_days": null,
"mfa_required": true,
"sso_enforced": false,
"default_workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q"
},
"member_count": 14,
"workspace_count": 3,
"created_at": "2025-04-17T11:20:00Z"
}| Field | Type | Description |
|---|---|---|
plan.name | string | The plan exactly as named on the Syntic platform, such as Business or Scale. |
plan.monthly_token_allowance | integer or null | Tokens included per month; null for unlimited. |
usage_credits | object | Whether credits are on, the balance, the monthly spend limit and auto-reload. |
rate_limit_tier | string | start, 1 to 4, or custom. |
settings | object | Retention, second-factor and sign-in settings, and the default workspace. |
Examples
curl -sS https://app.syntic.ai/v1/organizations/me \
-H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
-H "syntic-beta: admin-2026-11-01"Errors
Errors use the error envelope and carry a request_id. Codes specific to this operation:
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request_error | beta_required | The syntic-beta header is missing. |
| 403 | permission_error | role_required | The admin key’s creator does not have the role this needs. |
| 401 | authentication_error | invalid_api_key | The admin key is missing, unknown, revoked or expired. |
| 403 | permission_error | admin_key_required | An inference key was used. |
| 429 | rate_limit_error | rate_limited | Too many requests; wait for Retry-After. See Rate-limit headers. |
Related
Was this page helpful?