Organization info

⚠️

Preview — this feature is being built; the design below is the spec.

GET /v1/organizations/me returns the organization an admin key belongs to: its id, name, plan, and the settings that affect API traffic. Use it to confirm a key points at the organization you expect, to show the plan in an internal dashboard, or as the first call of any admin script.

Endpoints

Method	Path	Purpose	Role
`GET`	`/v1/organizations/me`	Read the organization.	Owner or Administrator
`PATCH`	`/v1/organizations/me`	Change the name or settings.	Owner (some fields: Administrator, as noted)

Authenticate with Authorization: Bearer sk_admin_... and send syntic-beta: admin-2026-11-01.

The organization object

{
  "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	Description
`id`	Starts with `org_`.
`name`	The display name.
`plan.name`	The plan exactly as named on the Syntic platform, for example `Free`, `Starter`, `Business`, `Pro`, `Scale`, `Operations` or `Enterprise`.
`plan.status`	`active`, `past_due`, `canceled` or `trialing`.
`plan.current_period_end`	When the current billing period ends and the monthly allowance resets.
`plan.monthly_token_allowance`	Tokens per month included in the plan, or `null` for unlimited. See Pricing.
`usage_credits`	Whether credits are on, the balance, the organization’s monthly spend limit and auto-reload. Change limits with Spend limits.
`rate_limit_tier`	`start`, `1` to `4`, or `custom`. See Rate-limit tiers.
`settings.zero_data_retention`	Whether the organization runs in zero data retention mode. Read-only here.
`settings.data_retention_days`	Retention for stored content: `7`, `30`, `90`, `365` or `null` (feature defaults).
`settings.mfa_required`	Members must use a second factor.
`settings.sso_enforced`	Sign-in must go through the organization’s single sign-on provider. Read-only here.
`settings.default_workspace_id`	The workspace that existing keys were placed in when workspaces launched.

Read the organization

curl -sS https://app.syntic.ai/v1/organizations/me \
  -H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
  -H "syntic-beta: admin-2026-11-01"

const res = await fetch('https://app.syntic.ai/v1/organizations/me', {
  headers: { Authorization: `Bearer ${process.env.SYNTIC_ADMIN_KEY}`, 'syntic-beta': 'admin-2026-11-01' },
})
const org = await res.json()
console.log(`${org.name} on ${org.plan.name}, tier ${org.rate_limit_tier}`)

import os, requests
 
org = requests.get(
    "https://app.syntic.ai/v1/organizations/me",
    headers={"Authorization": f"Bearer {os.environ['SYNTIC_ADMIN_KEY']}", "syntic-beta": "admin-2026-11-01"},
).json()
print(f"{org['name']} on {org['plan']['name']}, tier {org['rate_limit_tier']}")

Change the organization

PATCH /v1/organizations/me

Field	Who	Notes
`name`	Owner	1 to 100 characters.
`settings.data_retention_days`	Owner	`7`, `30`, `90`, `365` or `null`.
`settings.mfa_required`	Owner or Administrator	Turning it on asks members without a second factor to add one at next sign-in.

Plan changes, ownership transfer, zero data retention and single sign-on stay in the Console, because they involve payment or identity steps that need a person.

curl -sS -X PATCH https://app.syntic.ai/v1/organizations/me \
  -H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -H "syntic-beta: admin-2026-11-01" \
  -d '{"settings": {"data_retention_days": 30}}'

The response is the updated organization object. Each change writes an audit event (organization.updated, with the fields that changed).

Errors

Errors use the error envelope.

Status	`type`	`code`	When
400	`invalid_request_error`	`invalid_parameter`	A value outside the allowed set; `param` names it.
400	`invalid_request_error`	`read_only_field`	A field that cannot be changed through the API.
403	`permission_error`	`admin_key_required`	An inference key was used.
403	`permission_error`	`role_required`	An Administrator’s key tried an Owner-only change.

Build notes for the platform team

Wrap the existing organization admin function; return the real platform plan name, never a marketing label.
Read credit and auto-reload fields from the same source the Console’s Billing page uses.

Update an admin key Get the organization

Was this page helpful?