Super Admin API Key

Create organization via admin API key

post

Creates an organization by admin API key. The response includes organization details.

Authorizations
Super-Admin-Secret-KeystringRequired

Custom authentication header

Body
namestring · max: 255Required

Organization name.

Example: New Organization
subscriptionIdstring · uuidOptional

Subscription ID. Subscribes to trial subscription if undefined.

Example: 123e4567-e89b-12d3-a456-426614174000
endedAtstring · date-timeOptional

Subscription end date. Applies if "subscriptionId" is specified and this subscription is not a trial.

Example: 2024-03-20T12:00:00Z
Responses
post
/external/organizations

Get subscriptions by admin API key

get

Fetches subscriptions by admin API key. The response includes the subscriptions details.

Authorizations
Super-Admin-Secret-KeystringRequired

Custom authentication header

Query parameters
visibilitystring · enumOptional

Subscription visibility.

Example: publicPossible values:
statusstring · enumOptional

Subscription status.

Example: activePossible values:
Responses
chevron-right
200

Successfully retrieved subscriptions.

application/json
idstring · uuidRequired

Subscription ID.

Example: 123e4567-e89b-12d3-a456-426614174000
titlestringRequired

Subscription title.

Example: Subscription title
descriptionstringRequired

Subscription description.

Example: Subscription description
agentsAmountnumberRequired

Number of agents in the subscription.

Example: 10
tokensAmountPerMonthnumberRequired

OpenAI tokens amount in the subscription.

Example: 1000000
secondsAmountPerMonthnumberRequired

Vapi seconds amount in the subscription.

Example: 1000000
smsAmountPerMonthnumberRequired

Number of SMS in the subscription.

Example: 1000
emailsAmountPerMonthnumberRequired

Number of Emails in the subscription.

Example: 1000
usersWithAccessAmountnumberRequired

Number of users in organizations.

Example: 100
statusstring · enumRequired

Subscription status.

Example: activePossible values:
visibilitystring · enumRequired

Subscription visibility.

Example: publicPossible values:
isTrialbooleanRequired

True if subscription is trial.

Example: false
createdAtstring · date-timeRequired

Creation timestamp

Example: 2024-03-20T12:00:00Z
updatedAtstring · date-timeRequired

Last update timestamp

Example: 2024-03-20T12:00:00Z
organizationsCountnumberRequired

Number of organizations with current subscription.

Example: 100
pricenumberRequired

Subscription in cent.

Example: 49900
get
/external/subscriptions

Last updated