> ## Documentation Index > Fetch the complete documentation index at: https://polar.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get Organization > Get an organization by ID. ## OpenAPI ````yaml GET /v1/organizations/{id} openapi: 3.1.0 info: title: Polar API summary: Polar HTTP and Webhooks API description: Read the docs at https://polar.sh/docs/api-reference version: 0.1.0 servers: - url: https://api.polar.sh description: Production environment x-speakeasy-server-id: production - url: https://sandbox-api.polar.sh description: Sandbox environment x-speakeasy-server-id: sandbox security: - access_token: [] tags: - name: public description: >- Endpoints shown and documented in the Polar API documentation and available in our SDKs. - name: private description: >- Endpoints that should appear in the schema only in development to generate our internal JS SDK. - name: mcp description: Endpoints enabled in the MCP server. paths: /v1/organizations/{id}: get: tags: - organizations - public summary: Get Organization description: Get an organization by ID. operationId: organizations:get parameters: - name: id in: path required: true schema: type: string format: uuid4 examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 description: The organization ID. x-polar-selector-widget: resourceRoot: /v1/organizations resourceName: Organization displayProperty: name title: Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Organization' '404': description: Organization not found. content: application/json: schema: $ref: '#/components/schemas/ResourceNotFound' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-codeSamples: - lang: go label: Go (SDK) source: "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tpolargo \"github.com/polarsource/polar-go\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := polargo.New(\n polargo.WithSecurity(os.Getenv(\"POLAR_ACCESS_TOKEN\")),\n )\n\n res, err := s.Organizations.Get(ctx, \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\")\n if err != nil {\n log.Fatal(err)\n }\n if res.Organization != nil {\n // handle response\n }\n}" - lang: python label: Python (SDK) source: |- from polar_sdk import Polar with Polar( access_token="", ) as polar: res = polar.organizations.get(id="1dbfc517-0bbf-4301-9ba8-555ca42b9737") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { Polar } from "@polar-sh/sdk"; const polar = new Polar({ accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "", }); async function run() { const result = await polar.organizations.get({ id: "1dbfc517-0bbf-4301-9ba8-555ca42b9737", }); console.log(result); } run(); - lang: php label: PHP (SDK) source: |- declare(strict_types=1); require 'vendor/autoload.php'; use Polar; $sdk = Polar\Polar::builder() ->setSecurity( '' ) ->build(); $response = $sdk->organizations->get( id: '1dbfc517-0bbf-4301-9ba8-555ca42b9737' ); if ($response->organization !== null) { // handle response } components: schemas: Organization: properties: created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the object. name: type: string title: Name description: Organization name shown in checkout, customer portal, emails etc. slug: type: string title: Slug description: >- Unique organization slug in checkout, customer portal and credit card statements. avatar_url: anyOf: - type: string - type: 'null' title: Avatar Url description: Avatar URL shown in checkout, customer portal, emails etc. proration_behavior: $ref: '#/components/schemas/SubscriptionProrationBehavior' description: >- Proration behavior applied when customer updates their subscription from the portal. allow_customer_updates: type: boolean title: Allow Customer Updates description: >- Whether customers can update their subscriptions from the customer portal. email: anyOf: - type: string - type: 'null' title: Email description: Public support email. website: anyOf: - type: string - type: 'null' title: Website description: Official website of the organization. socials: items: $ref: '#/components/schemas/OrganizationSocialLink' type: array title: Socials description: Links to social profiles. status: $ref: '#/components/schemas/OrganizationStatus' description: Current organization status details_submitted_at: anyOf: - type: string format: date-time - type: 'null' title: Details Submitted At description: When the business details were submitted for review. default_presentment_currency: type: string title: Default Presentment Currency description: >- 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 applied on products. feature_settings: anyOf: - $ref: '#/components/schemas/OrganizationFeatureSettings' - type: 'null' description: Organization feature settings subscription_settings: $ref: '#/components/schemas/OrganizationSubscriptionSettings' description: Settings related to subscriptions management notification_settings: $ref: '#/components/schemas/OrganizationNotificationSettings' description: Settings related to notifications customer_email_settings: $ref: '#/components/schemas/OrganizationCustomerEmailSettings' description: Settings related to customer emails customer_portal_settings: $ref: '#/components/schemas/OrganizationCustomerPortalSettings' description: 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: Two-letter country code (ISO 3166-1 alpha-2). account_id: anyOf: - type: string format: uuid4 - type: 'null' title: Account Id description: ID of the transactions account. payout_account_id: anyOf: - type: string format: uuid4 - type: 'null' title: Payout Account Id description: ID of the payout account. capabilities: $ref: '#/components/schemas/OrganizationCapabilities' description: 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 - notification_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: The social platform of the URL url: type: string maxLength: 2083 minLength: 1 format: uri title: Url description: The URL to the organization profile type: object required: - platform - url title: OrganizationSocialLink OrganizationStatus: type: string enum: - created - review - snoozed - denied - active - blocked - offboarding title: OrganizationStatus TaxBehaviorOption: type: string enum: - location - inclusive - exclusive title: TaxBehaviorOption OrganizationFeatureSettings: properties: issue_funding_enabled: type: boolean title: Issue Funding Enabled description: If this organization has issue funding enabled default: false seat_based_pricing_enabled: type: boolean title: Seat Based Pricing Enabled description: If this organization has seat-based pricing enabled default: false wallets_enabled: type: boolean title: Wallets Enabled description: If this organization has Wallets enabled default: false member_model_enabled: type: boolean title: Member Model Enabled description: If this organization has the Member model enabled default: false tinybird_read: type: boolean title: Tinybird Read description: If this organization reads from Tinybird default: false tinybird_compare: type: boolean title: Tinybird Compare description: If this organization compares Tinybird results with database default: false checkout_localization_enabled: type: boolean title: Checkout Localization Enabled description: If this organization has checkout localization enabled default: false overview_metrics: anyOf: - items: type: string type: array - type: 'null' title: Overview Metrics description: Ordered list of metric slugs shown on the dashboard overview. reset_proration_behavior_enabled: type: boolean title: Reset Proration Behavior Enabled description: If this organization has access to reset proration behavior. 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 OrganizationNotificationSettings: properties: new_order: type: boolean title: New Order new_subscription: type: boolean title: New Subscription type: object required: - new_order - new_subscription title: OrganizationNotificationSettings 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: Whether the organization can accept new checkout payments. subscription_renewals: type: boolean title: Subscription Renewals description: Whether the organization can process subscription renewals. payouts: type: boolean title: Payouts description: Whether the organization can withdraw its balance. refunds: type: boolean title: Refunds description: Whether the organization can issue refunds. api_access: type: boolean title: Api Access description: Whether the organization can access the API. dashboard_access: type: boolean title: Dashboard Access description: 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: access_token: type: http scheme: bearer description: >- You can generate an **Organization Access Token** from your organization's settings. ````