Retrieve Organization

GEThttps://api.confident-ai.com/v2/organization

Retrieves the organization your API key is scoped to. Every other admin endpoint operates inside this organization, so its id is the one to pass wherever an organization id is asked for, and its plan is what decides which of those endpoints you are entitled to call.

GET/v2/organization

curl -X GET "https://api.confident-ai.com/v2/organization" \
  -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>"

200

{
  "success": true,
  "data": {
    "id": "<ORGANIZATION-ID>",
    "name": "Acme",
    "plan": "TRIAL",
    "created_at": "2025-01-14T09:30:00.000Z"
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Response

Retrieve Organization succeeded.

successboolean
Indicates if the request was successful.
dataobject
The tenant every project, API key and member belongs to. An organization API key is scoped to exactly one of these, so this is the top of the hierarchy the admin endpoints operate on.
Show 4 propertiesHide 4 properties
- idstring
  The id of the organization, generated by Confident AI.
- namestring
  The name of the organization.
- planenum
  The billing plan the organization is on, which decides its entitlements and usage limits. Plans rank FREE and TRIAL, then STARTER, PREMIUM, TEAM and ENTERPRISE, each carrying every lower plan's entitlements plus more projects and seats: FREE allows a single project, STARTER up to five, and the paid plans above it bill extra project spaces as usage. Some features are reserved outright — red teaming through the API is ENTERPRISE only. TRIAL is a time-limited run at paid entitlements; once the trial period has elapsed the organization is entitled as FREE, but this field keeps reporting the stored plan, so it is not a substitute for a 403 when deciding whether a call will be allowed.
  Show 6 enum valuesHide 6 enum values
  - TRIAL
  - FREE
  - STARTER
  - ENTERPRISE
  - TEAM
  - PREMIUM
- created_atstring
  When the organization was created.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI