API ReferenceUsers

User Organization Retrieve

View for managing organizations.

Special case: Organization model IS the org (no organization_id field). Uses ownership_object_field_name = “id” to check org.id == user.curr_org_id.

Authentication

AuthorizationBearer
JWT access token or Respan API key

Path parameters

unique_organization_idstringRequired

Response

idintegerRead-only
is_blockedbooleanRead-only
onboarding_methodenum or anyRead-only
namestring<=254 characters
statusenum
  • active - Active
  • deleting - Deleting
  • inactive - Inactive
stripe_customer_idstringRead-only
gateway_onboarding_completed_atdatetime or nullRead-only
tracing_onboarding_completed_atdatetime or nullRead-only
llm_gateway_markup_ratedoubleRead-only

LLM gateway markup rate (default 0% markup). Applied when Keywords AI provides LLM credentials. Formula: credit_charge = cost * (1 + llm_gateway_markup_rate)

company_organizationinteger or nullRead-only
userslist of integersRead-only
disabled_span_behaviorslist of strings

Behavior slugs excluded from span-behavior evaluation.

warnings_settingsobject or any
custom_property_index_mappingmap from strings to strings or null

Custom property key -> indexed ClickHouse column name (e.g. custom_string_1).

created_atdatetime or null
first_api_call_atdatetime or null
last_api_call_atdatetime or null
notesstring
digest_email_inboxeslist of strings
organization_sizeinteger-2147483648-2147483647
product_use_caseslist of strings
prioritize_objectiveslist of strings
unique_organization_idstring
budget_goalstring
monthly_spendingdouble
preset_modelslist of strings
preset_optionstring<=70 characters
dynamic_routing_enabledboolean
fallback_model_enabledboolean
fallback_modelslist of strings
alert_settingsany
system_fallback_enabledboolean
alerts_enabledboolean
disable_logboolean
has_api_callboolean
onboardedboolean
has_api_call_with_non_default_keyboolean
onboarding_integration_optionsany
onboarding_keystring<=50 characters
curr_onboarding_stepinteger-2147483648-2147483647
onboarding_startdatetime
onboarding_enddatetime or null
enable_cacheboolean
archive_durationinteger-2147483648-2147483647
cache_saved_costdouble
cache_hit_countlong-9223372036854776000-9223372036854776000
cache_hit_tokenslong-9223372036854776000-9223372036854776000
omit_log_when_cache_hitboolean
cache_saved_timedouble
last_cache_aggregations_updatedatetime
classification_percentagedouble or null
use_custom_credentialsboolean
default_customer_user_budgetdouble or null
credit_low_balance_thresholddouble or null

Credit balance threshold (in USD) to trigger low balance warning webhook. When credit balance drops below this value, a credit_low_balance_threshold_reached webhook event is dispatched once until balance goes above threshold again.

credit_auto_top_off_thresholddouble or null

Credit balance threshold (in USD) to trigger auto top-off. When credit balance drops below this value, automatically charge credit_auto_top_off_amount via Stripe.

credit_auto_top_off_amountdouble or null

Amount (in USD) to automatically charge when credit balance drops below credit_auto_top_off_threshold. Requires stripe_customer_id with valid payment method.

is_auto_top_off_enabledboolean

Enable automatic credit top-off. When enabled and balance drops below credit_auto_top_off_threshold, automatically charges credit_auto_top_off_amount via Stripe. Requires stripe_customer_id with valid payment method.

metadata_keyslist of strings or null
custom_modelslist of strings or null
spend_capdouble or null

Spend cap amount in USD. Enforced in real-time via atomic Redis limiter.

spend_cap_warning_thresholddouble or null
Spend threshold in USD to trigger warning alert.
budget_durationenum

Duration for spend_cap enforcement: daily, weekly, or monthly.

  • daily - daily
  • weekly - weekly
  • monthly - monthly
use_keywordsai_credentialsboolean
rate_limitdouble or null
customer_user_rate_limitdouble or null
retry_enabledboolean
retry_afterdouble
num_retriesinteger-2147483648-2147483647
custom_preset_modelslist of strings
image_assetslist of strings
logs_retention_period_in_daysinteger or null-2147483648-2147483647
is_extended_retention_enabledboolean
is_custom_retention_enabledboolean
starredboolean
is_span_behaviors_enabledboolean
curr_ownerinteger or null