> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getruba.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Read Organization
> ### Intent
Reads the organization without changing it.
### When to call it
Call this after your application has received or stored the identifier for the organization.
### Access boundary
Authorize the request with a token that carries `organizations:read` or `organizations:write`.
### Successful result
A successful request returns `200`. The response schema below defines the body your integration receives.
export const RubaSocials = () => {
if (typeof document === "undefined") {
return null;
}
const inject = () => {
const footer = document.getElementById("footer");
if (!footer || document.getElementById("ruba-socials")) {
return false;
}
const isDark = document.querySelector("html.dark") || document.querySelector('html[class*="dark"]');
const lineColor = isDark ? "#383838" : "#e8e8ed";
const iconColor = isDark ? "#8e8e93" : "#86868b";
const markColor = isDark ? "#ffffff" : "#08080c";
const hoverColor = "#0071e3";
const div = document.createElement("div");
div.id = "ruba-socials";
div.style.cssText = `display:flex;align-items:center;gap:20px;padding-top:20px;margin-top:20px;border-top:1px solid ${lineColor};width:100%`;
const logo = `Ruba`;
const spacer = ``;
const ig = ``;
const li = ``;
const x = ``;
const github = ``;
div.innerHTML = logo + spacer + ig + li + x + github;
footer.appendChild(div);
return true;
};
if (!document.documentElement.dataset.rubaSocialsObserver) {
document.documentElement.dataset.rubaSocialsObserver = "true";
const observer = new MutationObserver(() => {
if (!document.getElementById("ruba-socials")) {
inject();
}
});
observer.observe(document.body, {
childList: true,
subtree: true
});
}
setTimeout(() => {
if (!inject()) {
const interval = setInterval(() => {
if (inject()) {
clearInterval(interval);
}
}, 500);
setTimeout(() => clearInterval(interval), 10000);
}
}, 300);
return null;
};
## OpenAPI
````yaml GET /v1/organizations/{id}
openapi: 3.1.0
info:
title: Ruba API
summary: Ruba HTTP and Webhooks API
description: '**Details:** Read the docs at https://docs.getruba.com/api-reference.'
version: 2026-04
servers:
- url: https://api.getruba.com
description: '**Details:** Production environment.'
x-speakeasy-server-id: production
- url: https://sandbox-api.getruba.com
description: '**Details:** Sandbox environment.'
x-speakeasy-server-id: sandbox
security: []
tags:
- name: public
description: >-
**Details:** Endpoints shown and documented in the Ruba API documentation
and available in our SDKs.
- name: private
description: >-
**Details:** Endpoints that should appear in the schema only in
development to generate our internal JS SDK.
paths:
/v1/organizations/{id}:
get:
tags:
- organizations
- public
summary: Read Organization
description: >-
### Intent
Reads the organization without changing it.
### When to call it
Call this after your application has received or stored the identifier
for the organization.
### Access boundary
Authorize the request with a token that carries `organizations:read` or
`organizations:write`.
### Successful result
A successful request returns `200`. The response schema below defines
the body your integration receives.
operationId: organizations:get
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid4
examples:
- 1dbfc517-0bbf-4301-9ba8-555ca42b9737
description: Identifier of the organization.
x-ruba-selector-widget:
resourceRoot: /v1/organizations
resourceName: Organization
displayProperty: name
title: Id
responses:
'200':
description: Request completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Organization'
'404':
description: '**Response:** Organization could not be found.'
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFound'
'422':
description: Request validation failed
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- oidc:
- organizations:read
- organizations:write
- pat:
- organizations:read
- organizations:write
- oat:
- organizations:read
- organizations:write
components:
schemas:
Organization:
properties:
created_at:
type: string
format: date-time
title: Created At
description: The time Ruba created this record.
modified_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Modified At
description: The time this record last changed.
id:
type: string
format: uuid4
title: Id
description: The stable identifier for this record.
name:
type: string
title: Name
description: >-
**Name:** Organization name shown in checkout, customer portal,
emails etc.
slug:
type: string
title: Slug
description: >-
**Slug:** Unique organization slug in checkout, customer portal and
credit card statements.
avatar_url:
anyOf:
- type: string
- type: 'null'
title: Avatar Url
description: >-
**Avatar Url:** Avatar URL shown in checkout, customer portal,
emails etc.
proration_behavior:
$ref: '#/components/schemas/SubscriptionProrationBehavior'
description: >-
**Proration Behavior:** Proration behavior applied when customer
updates their subscription from the portal.
allow_customer_updates:
type: boolean
title: Allow Customer Updates
description: >-
Indicates whether customers can update their subscriptions from the
customer portal.
email:
anyOf:
- type: string
- type: 'null'
title: Email
description: '**Email:** Public support email.'
website:
anyOf:
- type: string
- type: 'null'
title: Website
description: '**Website:** Official website of the organization.'
socials:
items:
$ref: '#/components/schemas/OrganizationSocialLink'
type: array
title: Socials
description: '**Socials:** Links to social profiles.'
status:
$ref: '#/components/schemas/OrganizationStatus'
description: '**Status:** Current organization status.'
details_submitted_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Details Submitted At
description: >-
**Details Submitted At:** When the business details were submitted
for review.
default_presentment_currency:
type: string
title: Default Presentment Currency
description: >-
**Default Presentment Currency:** Default presentment currency. Used
as fallback in checkout and customer portal, if the customer's local
currency is not available.
default_tax_behavior:
$ref: '#/components/schemas/TaxBehaviorOption'
description: '**Default Tax Behavior:** Default tax behavior applied on products.'
feature_settings:
anyOf:
- $ref: '#/components/schemas/OrganizationFeatureSettings'
- type: 'null'
description: '**Feature Settings:** Organization feature settings.'
subscription_settings:
$ref: '#/components/schemas/OrganizationSubscriptionSettings'
description: >-
**Subscription Settings:** Settings related to subscriptions
management.
customer_email_settings:
$ref: '#/components/schemas/OrganizationCustomerEmailSettings'
description: '**Customer Email Settings:** Settings related to customer emails.'
customer_portal_settings:
$ref: '#/components/schemas/OrganizationCustomerPortalSettings'
description: >-
**Customer Portal Settings:** Settings related to the customer
portal.
country:
anyOf:
- type: string
enum:
- AD
- AE
- AF
- AG
- AI
- AL
- AM
- AO
- AQ
- AR
- AS
- AT
- AU
- AW
- AX
- AZ
- BA
- BB
- BD
- BE
- BF
- BG
- BH
- BI
- BJ
- BL
- BM
- BN
- BO
- BQ
- BR
- BS
- BT
- BV
- BW
- BY
- BZ
- CA
- CC
- CD
- CF
- CG
- CH
- CI
- CK
- CL
- CM
- CN
- CO
- CR
- CU
- CV
- CW
- CX
- CY
- CZ
- DE
- DJ
- DK
- DM
- DO
- DZ
- EC
- EE
- EG
- EH
- ER
- ES
- ET
- FI
- FJ
- FK
- FM
- FO
- FR
- GA
- GB
- GD
- GE
- GF
- GG
- GH
- GI
- GL
- GM
- GN
- GP
- GQ
- GR
- GS
- GT
- GU
- GW
- GY
- HK
- HM
- HN
- HR
- HT
- HU
- ID
- IE
- IL
- IM
- IN
- IO
- IQ
- IR
- IS
- IT
- JE
- JM
- JO
- JP
- KE
- KG
- KH
- KI
- KM
- KN
- KP
- KR
- KW
- KY
- KZ
- LA
- LB
- LC
- LI
- LK
- LR
- LS
- LT
- LU
- LV
- LY
- MA
- MC
- MD
- ME
- MF
- MG
- MH
- MK
- ML
- MM
- MN
- MO
- MP
- MQ
- MR
- MS
- MT
- MU
- MV
- MW
- MX
- MY
- MZ
- NA
- NC
- NE
- NF
- NG
- NI
- NL
- 'NO'
- NP
- NR
- NU
- NZ
- OM
- PA
- PE
- PF
- PG
- PH
- PK
- PL
- PM
- PN
- PR
- PS
- PT
- PW
- PY
- QA
- RE
- RO
- RS
- RU
- RW
- SA
- SB
- SC
- SD
- SE
- SG
- SH
- SI
- SJ
- SK
- SL
- SM
- SN
- SO
- SR
- SS
- ST
- SV
- SX
- SY
- SZ
- TC
- TD
- TF
- TG
- TH
- TJ
- TK
- TL
- TM
- TN
- TO
- TR
- TT
- TV
- TW
- TZ
- UA
- UG
- UM
- US
- UY
- UZ
- VA
- VC
- VE
- VG
- VI
- VN
- VU
- WF
- WS
- YE
- YT
- ZA
- ZM
- ZW
title: CountryAlpha2
x-speakeasy-enums:
- AD
- AE
- AF
- AG
- AI
- AL
- AM
- AO
- AQ
- AR
- AS
- AT
- AU
- AW
- AX
- AZ
- BA
- BB
- BD
- BE
- BF
- BG
- BH
- BI
- BJ
- BL
- BM
- BN
- BO
- BQ
- BR
- BS
- BT
- BV
- BW
- BY
- BZ
- CA
- CC
- CD
- CF
- CG
- CH
- CI
- CK
- CL
- CM
- CN
- CO
- CR
- CU
- CV
- CW
- CX
- CY
- CZ
- DE
- DJ
- DK
- DM
- DO
- DZ
- EC
- EE
- EG
- EH
- ER
- ES
- ET
- FI
- FJ
- FK
- FM
- FO
- FR
- GA
- GB
- GD
- GE
- GF
- GG
- GH
- GI
- GL
- GM
- GN
- GP
- GQ
- GR
- GS
- GT
- GU
- GW
- GY
- HK
- HM
- HN
- HR
- HT
- HU
- ID
- IE
- IL
- IM
- IN
- IO
- IQ
- IR
- IS
- IT
- JE
- JM
- JO
- JP
- KE
- KG
- KH
- KI
- KM
- KN
- KP
- KR
- KW
- KY
- KZ
- LA
- LB
- LC
- LI
- LK
- LR
- LS
- LT
- LU
- LV
- LY
- MA
- MC
- MD
- ME
- MF
- MG
- MH
- MK
- ML
- MM
- MN
- MO
- MP
- MQ
- MR
- MS
- MT
- MU
- MV
- MW
- MX
- MY
- MZ
- NA
- NC
- NE
- NF
- NG
- NI
- NL
- 'NO'
- NP
- NR
- NU
- NZ
- OM
- PA
- PE
- PF
- PG
- PH
- PK
- PL
- PM
- PN
- PR
- PS
- PT
- PW
- PY
- QA
- RE
- RO
- RS
- RU
- RW
- SA
- SB
- SC
- SD
- SE
- SG
- SH
- SI
- SJ
- SK
- SL
- SM
- SN
- SO
- SR
- SS
- ST
- SV
- SX
- SY
- SZ
- TC
- TD
- TF
- TG
- TH
- TJ
- TK
- TL
- TM
- TN
- TO
- TR
- TT
- TV
- TW
- TZ
- UA
- UG
- UM
- US
- UY
- UZ
- VA
- VC
- VE
- VG
- VI
- VN
- VU
- WF
- WS
- YE
- YT
- ZA
- ZM
- ZW
- type: 'null'
description: '**Country:** Two-letter country code (ISO 3166-1 alpha-2).'
account_id:
anyOf:
- type: string
format: uuid4
- type: 'null'
title: Account Id
description: Identifier of the transactions account.
payout_account_id:
anyOf:
- type: string
format: uuid4
- type: 'null'
title: Payout Account Id
description: Identifier of the payout account.
capabilities:
$ref: '#/components/schemas/OrganizationCapabilities'
description: >-
**Capabilities:** Capabilities currently granted to the
organization.
type: object
required:
- created_at
- modified_at
- id
- name
- slug
- avatar_url
- proration_behavior
- allow_customer_updates
- email
- website
- socials
- status
- details_submitted_at
- default_presentment_currency
- default_tax_behavior
- feature_settings
- subscription_settings
- customer_email_settings
- customer_portal_settings
- account_id
- payout_account_id
- capabilities
title: Organization
ResourceNotFound:
properties:
error:
type: string
const: ResourceNotFound
title: Error
examples:
- ResourceNotFound
detail:
type: string
title: Detail
type: object
required:
- error
- detail
title: ResourceNotFound
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
SubscriptionProrationBehavior:
type: string
enum:
- invoice
- prorate
- next_period
- reset
title: SubscriptionProrationBehavior
OrganizationSocialLink:
properties:
platform:
$ref: '#/components/schemas/OrganizationSocialPlatforms'
description: '**Platform:** Social platform of the URL.'
url:
type: string
maxLength: 2083
minLength: 1
format: uri
title: Url
description: '**Url:** URL to the organization profile.'
type: object
required:
- platform
- url
title: OrganizationSocialLink
OrganizationStatus:
type: string
enum:
- created
- review
- snoozed
- denied
- active
- blocked
- offboarding
- offboarded
title: OrganizationStatus
TaxBehaviorOption:
type: string
enum:
- location
- inclusive
- exclusive
title: TaxBehaviorOption
OrganizationFeatureSettings:
properties:
issue_funding_enabled:
type: boolean
title: Issue Funding Enabled
description: >-
**Issue Funding Enabled:** If this organization has issue funding
enabled.
default: false
seat_based_pricing_enabled:
type: boolean
title: Seat Based Pricing Enabled
description: >-
**Seat Based Pricing Enabled:** If this organization has seat-based
pricing enabled.
default: false
wallets_enabled:
type: boolean
title: Wallets Enabled
description: '**Wallets Enabled:** If this organization has Wallets enabled.'
default: false
member_model_enabled:
type: boolean
title: Member Model Enabled
description: >-
**Member Model Enabled:** If this organization has the Member model
enabled.
default: false
checkout_localization_enabled:
type: boolean
title: Checkout Localization Enabled
description: >-
**Checkout Localization Enabled:** If this organization has checkout
localization enabled.
default: false
overview_metrics:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Overview Metrics
description: >-
**Overview Metrics:** Ordered list of metric slugs shown on the
dashboard overview.
reset_proration_behavior_enabled:
type: boolean
title: Reset Proration Behavior Enabled
description: >-
**Reset Proration Behavior Enabled:** If this organization has
access to reset proration behavior.
default: false
off_session_charges_enabled:
type: boolean
title: Off Session Charges Enabled
description: >-
**Off Session Charges Enabled:** If this organization can create and
finalize draft orders via the API (off-session charges against a
saved payment method).
default: false
slack_benefit_enabled:
type: boolean
title: Slack Benefit Enabled
description: '**Slack Benefit Enabled:** Enables the slack shared channel benefit.'
default: false
preview_access_enabled:
type: boolean
title: Preview Access Enabled
description: >-
**Preview Access Enabled:** If this organization has preview access
to new features enabled.
default: false
disputes_enabled:
type: boolean
title: Disputes Enabled
description: >-
**Disputes Enabled:** If this organization has the disputes
dashboard enabled.
default: false
type: object
title: OrganizationFeatureSettings
OrganizationSubscriptionSettings:
properties:
allow_multiple_subscriptions:
type: boolean
title: Allow Multiple Subscriptions
proration_behavior:
type: string
enum:
- invoice
- prorate
- next_period
title: PublicSubscriptionProrationBehavior
benefit_revocation_grace_period:
type: integer
title: Benefit Revocation Grace Period
prevent_trial_abuse:
type: boolean
title: Prevent Trial Abuse
allow_customer_updates:
type: boolean
title: Allow Customer Updates
type: object
required:
- allow_multiple_subscriptions
- proration_behavior
- benefit_revocation_grace_period
- prevent_trial_abuse
- allow_customer_updates
title: OrganizationSubscriptionSettings
OrganizationCustomerEmailSettings:
properties:
order_confirmation:
type: boolean
title: Order Confirmation
subscription_cancellation:
type: boolean
title: Subscription Cancellation
subscription_confirmation:
type: boolean
title: Subscription Confirmation
subscription_cycled:
type: boolean
title: Subscription Cycled
subscription_cycled_after_trial:
type: boolean
title: Subscription Cycled After Trial
subscription_past_due:
type: boolean
title: Subscription Past Due
subscription_renewal_reminder:
type: boolean
title: Subscription Renewal Reminder
subscription_revoked:
type: boolean
title: Subscription Revoked
subscription_trial_conversion_reminder:
type: boolean
title: Subscription Trial Conversion Reminder
subscription_uncanceled:
type: boolean
title: Subscription Uncanceled
subscription_updated:
type: boolean
title: Subscription Updated
type: object
required:
- order_confirmation
- subscription_cancellation
- subscription_confirmation
- subscription_cycled
- subscription_cycled_after_trial
- subscription_past_due
- subscription_renewal_reminder
- subscription_revoked
- subscription_trial_conversion_reminder
- subscription_uncanceled
- subscription_updated
title: OrganizationCustomerEmailSettings
OrganizationCustomerPortalSettings:
properties:
usage:
$ref: '#/components/schemas/CustomerPortalUsageSettings'
subscription:
$ref: '#/components/schemas/CustomerPortalSubscriptionSettings'
customer:
$ref: '#/components/schemas/CustomerPortalCustomerSettings'
type: object
required:
- usage
- subscription
title: OrganizationCustomerPortalSettings
OrganizationCapabilities:
properties:
checkout_payments:
type: boolean
title: Checkout Payments
description: Indicates whether the organization can accept new checkout payments.
subscription_renewals:
type: boolean
title: Subscription Renewals
description: >-
Indicates whether the organization can process subscription
renewals.
payouts:
type: boolean
title: Payouts
description: Indicates whether the organization can withdraw its balance.
refunds:
type: boolean
title: Refunds
description: Indicates whether the organization can issue refunds.
api_access:
type: boolean
title: Api Access
description: Indicates whether the organization can access the API.
dashboard_access:
type: boolean
title: Dashboard Access
description: Indicates whether the organization can access the dashboard.
type: object
required:
- checkout_payments
- subscription_renewals
- payouts
- refunds
- api_access
- dashboard_access
title: OrganizationCapabilities
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
OrganizationSocialPlatforms:
type: string
enum:
- x
- github
- facebook
- instagram
- youtube
- tiktok
- linkedin
- threads
- discord
- other
title: OrganizationSocialPlatforms
CustomerPortalUsageSettings:
properties:
show:
type: boolean
title: Show
type: object
required:
- show
title: CustomerPortalUsageSettings
CustomerPortalSubscriptionSettings:
properties:
update_seats:
type: boolean
title: Update Seats
update_plan:
type: boolean
title: Update Plan
type: object
required:
- update_seats
- update_plan
title: CustomerPortalSubscriptionSettings
CustomerPortalCustomerSettings:
properties:
allow_email_change:
type: boolean
title: Allow Email Change
type: object
title: CustomerPortalCustomerSettings
securitySchemes:
oidc:
type: openIdConnect
openIdConnectUrl: /.well-known/openid-configuration
pat:
type: http
description: >-
**Authentication:** You can generate a **Personal Access Token** from
your [settings](https://getruba.com/settings).
scheme: bearer
oat:
type: http
description: >-
**Authentication:** You can generate an **Organization Access Token**
from your organization's settings.
scheme: bearer
````