v1

latestOpenAPI 3.1.02026-08-06213193627.0 KB

orgs

Get Org

Get current user's Organization -- unless it's a personal org. -- Permissions: Every user can read this.

get/v1/orgs

Response

Successful Response

prompt_tokensinteger

Number of tokens the request used

completion_tokensinteger

Number of tokens the response used

total_tokensinteger

Number of tokens of (request + response)

prompt_tokens_costnumber

Cost (in $) of the prompt

completion_tokens_costnumber

Cost (in $) of the response

total_tokens_costnumber

Cost (in $) of the (request + response)

prompt_tokens_cost_savingsnumber

Cost (in $) saved in the prompt costs comparison to the benchmark model

completion_tokens_cost_savingsnumber

Cost (in $) saved in the completion costs comparison to the benchmark model

total_tokens_cost_savingsnumber

Cost (in $) saved in total, in comparison to the benchmark model

num_requestsinteger

The number of requests this Organization has performed in the current cycle

num_appsinteger

The number of active apps this Organization has

org_stripe_idstring required

The Stripe's customer ID. cus_xxxxxx

spaces_subscription_tier'INTERNAL' | 'FREE' | 'PRO' | 'TEAM' | 'ENTERPRISE'

spaces_subscription_seatsinteger nullable

The number of seats for the spaces subscription tier

spaces_subscription_status'active' | 'unpaid'

spaces_subscription_cancel_atinteger nullable

The date a subscription ends once it is cancelled

last_invoice_dateinteger required

Timestamp of last time we synced costs with Stripe. Usually coincides with the invoice.created webhook event

subscription_cycle'monthly' | 'yearly' nullable

The length of the Platform subscription cycle. Useful for upgrades and downgrades

The subscription tier this user is in.

subscription_price_idstring nullable

PRICE ID (on Stripe). The user's current Subscription ID is created from this Price

trial_endinteger nullable

The timestamp (in s) when the trial will end and the paid subscription will start. The user will be billed at this point

currency'usd'

The currency for this organization

billing_emailstring nullable

Billing email

free_balancenumber nullable

If this is > 0 and the user is in a TRIAL, we will deduct the balance from here.

spending_limit_softnumber nullable

spending_limit_hardnumber nullable

org_namestring required

org_creatorstring required

is_activeboolean

is_personalboolean

org_display_namestring nullable

org_logostring nullable

address_1string nullable

address_2string nullable

address_citystring nullable

address_zipstring nullable

address_statestring nullable

address_countrystring nullable

added_onstring date-time nullable

modified_onstring date-time nullable

hubspot_idstring nullable

prom_idstring nullable

prom_tokenstring nullable

prom_endpointstring nullable

loki_idstring nullable

loki_tokenstring nullable

loki_endpointstring nullable

rate_limitinteger

The rate limit for this org, per minute

idstring uuid required