orgs
Open an operation to see its authentication, its parameters and the fields of its request and response.
2 operations
GET/v1/organization
The organization and its plan (owner, admin, reviewer).
/v1/organizationAuthentication: Dashboard session
Response 200
| Name | Type | Description |
|---|---|---|
organizationrequired | object | |
organization.idrequired | string | |
organization.namerequired | string | |
organization.slugrequired | string | |
organization.typerequired | enum | Values direct | agency |
organization.planrequired | enum | Values none | open_source | indie | startup | growth | managed | agency | enterprise |
organization.subscription_statusrequired | enum | Values none | trialing | active | past_due | canceled | incomplete | lifetime |
organization.trial_ends_atrequired | string (date-time) | |
organization.current_period_endrequired | string (date-time) | |
organization.plan_activated_atrequired | string (date-time) | |
organization.billing_emailrequired | string (email) | |
organization.spend_cap_usdrequired | number | |
organization.show_engine_brandrequired | boolean | |
organization.patterns_opt_inrequired | boolean | |
organization.badge_removal_addonrequired | boolean | |
organization.overage_enabledrequired | boolean | |
organization.retention_daysrequired | integer | |
organization.signup_sourcerequired | enum | Values direct | badge | referral | vexp | open_source | partner |
organization.referral_coderequired | string | |
organization.localerequired | enum | Values en | it |
organization.sso_enforcedrequired | boolean | |
organization.approval_min_approversrequired | integer | |
organization.approval_rolesrequired | array of enum | |
organization.stripe_connect_account_idrequired | string | |
organization.connect_charges_enabledrequired | boolean | |
organization.demo_used_atrequired | string (date-time) | |
organization.created_atrequired | string (date-time) | |
organization.updated_atrequired | string (date-time) | |
planrequired | object | |
plan.idrequired | enum | Values none | open_source | indie | startup | growth | managed | agency | enterprise |
plan.namerequired | string | |
plan.featuresrequired | array of enum | |
plan.autonomyrequired | array of enum | |
plan.execution_modesrequired | array of enum | |
plan.limitsrequired | object | |
plan.limits.tickets_per_monthrequired | integer | |
plan.limits.repositories_per_workspacerequired | integer | |
plan.limits.public_repos_onlyrequired | boolean | |
plan.limits.workspaces_includedrequired | integer | |
plan.limits.extra_workspace_price_usdrequired | number | |
plan.limits.included_fixes_per_monthrequired | integer | |
plan.limits.overage_fix_price_usdrequired | number |
PATCH/v1/organization
Updates the name, language and data retention (owner, admin).
/v1/organizationAuthentication: Dashboard session
Request body
| Name | Type | Description |
|---|---|---|
name | string | |
locale | enum | Values en | it |
retention_days | integer |
Response 200
The same fields as GET /v1/organization.