List organizations the current user or API client belongs to

GET https://api.suger.cloud/org

List all organizations (also known as accounts or tenants) that the authenticated caller has access to. Returns organization details including name, status, cloud marketplace partners, and settings. Use this to discover which organizations you can operate on before calling org-scoped APIs like ListProducts, ListOffers, or ListEntitlements. The caller can be a user (returns orgs the user is a member of) or an API client (returns orgs the API client is authorized for).

Responses

200 — Success

Content-Type: application/json

ListOrganizationsByUserRow fields:

Field	Type	Required	Description
`allowedAuthMethods`	array<string>	no
`authID`	string	no
`createdBy`	string	no
`creationTime`	string	no
`description`	string	no
`emailDomain`	string	no
`environment`	OrganizationEnvironment	no
`expireAt`	string	no	nullable
`id`	string	no
`info`	OrganizationInfo	no
`joinOrganizationTime`	string	no
`lastUpdateTime`	string	no
`name`	string	no
`status`	string	no
`type`	OrganizationType	no
`userEmail`	string	no
`userID`	string	no
`userName`	string	no	The following fields are not included in the DB schema.
`userRole`	string	no
`website`	string	no

OrganizationInfo fields:

Field	Type	Required	Description
`aiBillingConfig`	AIBillingConfig	no
`clientSignupPageConfigInfo`	ClientSignupPageConfigInfo	no
`cosellAccountMappingConfigs`	array<CosellAccountMappingConfig>	no	CosellAccountMappingConfigs store the per-CRM Account / Opportunity field-name overrides consumed by partner-contact-metrics and other PRM read paths. One entry per (organization, CrmPartner). Nil or absent entry for a partner ⇒ no override saved ⇒ all slots default to standard field names. See pkg/structs/cosell_mapping.go.
`cosellConfigInfoV2`	array<structs.CosellConfigInfo>	no	Store the cosell configuration information of the organization.
`cosellFillerConfigInfo`	array<structs.CosellFillerConfigInfo>	no	Store the cosell configuration fillers
`cosellIntelligenceConfigInfo`	CosellIntelligenceConfigInfo	no
`fundingApplicationFieldMappingConfigInfo`	array<structs.FundingApplicationFieldMappingConfigInfo>	no	Store funding application field mapping config info list.
`notificationConfigInfo`	NotificationConfigInfo	no
`offerFillerConfigInfos`	array<OfferFillerConfigInfo>	no	Store the offer preview by field-mapping-v2 filler configs Deprecated
`offerFillerCrmPartnerConfigInfos`	object	no	Deprecated
`organizationConfigInfo`	OrganizationConfigInfo	no
`privateOfferConfigInfo`	PrivateOfferConfigInfo	no
`ssoConfigInfo`	SSOConfigInfo	no
`usageMeteringConfigInfo`	UsageMeteringConfigInfo	no

AIBillingConfig fields:

Field	Type	Required	Description
`billingEmail`	string	no	Override email for invoice delivery. If empty, invoices go to the org creator's email.
`disabledAt`	string	no	When AI usage was disabled, if applicable.
`disabledReason`	AIBillingDisabledReason	no
`enabled`	boolean	no	Whether AI usage billing is enabled for this organization. Default is true. Set to false to disable AI features.
`monthlyCreditCents`	integer	no	Monthly credit in cents. Default is 10000 ($100). Set to 0 for no credit, or a custom value for VIP customers.
`monthlySpendingCapCents`	integer	no	Monthly spending cap in cents. Default is 50000 ($500). Set to nil for unlimited spending.

ClientSignupPageConfigInfo fields:

Field	Type	Required	Description
`ccEmails`	array<string>	no	The cc email contacts of the new client signup notification.
`companyLogoUrl`	string	no	The company logo url of the seller/ISV.
`companyName`	string	no	The company name of the seller/ISV to show in the client signup page.
`customEmailTemplate`	string	no	Custom email template used as template
`customTemplate`	string	no	Custom template used as template
`enableCustomEmailTemplate`	boolean	no	If true, custom email template will be used
`enableCustomTemplate`	boolean	no	If true, custom template will be used
`enableHeadlessEntitlementsReport`	boolean	no	Enable headless entitlements report. Once enabled, the headless entitlements report will be sent as notification events. Each report contains the headless entitlements who are created in the past 3 days, but never have new client signup connected.
`enableUpdateBuyer`	boolean	no	Enable to update buyer information with the new client signup info. If true, the buyer information will be updated with the new client signup info. If false, the buyer information will not be updated with the new client signup info.
`hideCloudPartnerLogo`	boolean	no	If true, the cloud partner logo will no show in the new client signup page.
`landingImageUrl`	string	no	The signup landing image aws url of the organization
`notificationEmailSubject`	string	no	The email subject of the new client signup notification.
`publicNotes`	string	no	The public notes to append in new client signup notification email.
`signupId`	string	no	The signup ID for the new client signup page url. It is populated by Suger service when creating the new client signup page.
`videoLink`	string	no	The video link of the product. Optional.

CosellAccountMappingConfig fields:

Field	Type	Required
`account`	AccountFieldMapping	no
`crmPartner`	Partner	no
`lastValidatedAt`	string	no
`opportunity`	OpportunityFieldMapping	no

structs.CosellConfigInfo fields:

Field	Type	Required
`cloudPartner`	Partner	no
`crmPartner`	Partner	no
`info`	structs.CosellPairConfigInfo	no

structs.CosellFillerConfigInfo fields:

Field	Type	Required	Description
`from`	Partner	no
`lastModifyTime`	string	no	LastModifyTime is the last modify time of the from-to configuration.
`mappingInfo`	structs.CosellFillerFieldMappingInfo	no
`to`	Partner	no
`version`	string	no	Version indicates the configuration schema version for backward compatibility. The default value is an empty string.

CosellIntelligenceConfigInfo fields:

Field	Type	Required	Description
`awsSignalsEnabled`	boolean	no	Per-cloud signal toggles are optional. We use *bool so we can distinguish three states: - nil: not set — fall back to the legacy/global CosellIntelligenceSignalsEnabled value - true: explicitly enabled for this cloud - false: explicitly disabled for this cloud This preserves backward compatibility for orgs that only have the legacy field set while allowing clients to make explicit per-cloud overrides. AwsSignalsEnabled controls whether AWS co-sell intelligence signals are enabled
`azureSignalsEnabled`	boolean	no	AzureSignalsEnabled controls whether Azure co-sell intelligence signals are enabled
`cosellIntelligenceSignalsEnabled`	boolean	no	CosellIntelligenceSignalsEnabled controls whether co-sell intelligence signals are enabled for the organization
`gcpSignalsEnabled`	boolean	no	GcpSignalsEnabled controls whether GCP co-sell intelligence signals are enabled

structs.FundingApplicationFieldMappingConfigInfo fields:

Field	Type	Required
`cloudPartner`	Partner	no
`crmPartner`	Partner	no
`fundingType`	string	no
`lastModifyTime`	string	no
`mappingInfo`	structs.FundingApplicationFieldMappingInfo	no
`programType`	string	no

NotificationConfigInfo fields:

Field	Type	Required	Description
`allEmailNotificationScopes`	array<NotificationScope>	no	All available email notification scopes for the organization. It is used to populate the UI.
`crmFieldOptionsByCrm`	object	no	CrmFieldOptionsByCrm is a read-only capability map keyed by CrmSource. Per-org integration-filtered: only CRM keys whose service=CRM integration exists for the org are emitted. Drives the FE's "+ Add dynamic recipient ▾ → Salesforce / HubSpot ▸" branches. Ignored on inbound (PATCH) requests.
`daysToExpireSoonOfferWorkflowNotification`	integer	no	The number of days before offer expiration to trigger the workflow notification. Only applicable when EnableExpireSoonOfferWorkflowNotification is true. Default is 7 days if not specified.
`defaultSenderEmail`	string	no	DefaultSenderEmail is the read-only "from" address used when a scope has no custom sender (the default Suger SES no-reply address, e.g. "no-reply@suger.cloud"). Set by the GetNotificationConfigInfo handler from the environment's SES domain so the FE can show the concrete address. Ignored on inbound (PATCH) requests.
`disableEmailNotificationOnOfferReady`	boolean	no	Enable to email notification events to buyers
`emailNotificationScopeEventConfigs`	object	no	The per-scope-event email notification configurations. The key is the NotificationScope (e.g., "CREATE.OFFER"). Each scope has its own independent config with enabled state, recipients, and optional template override.
`enableEmailNotification`	boolean	no	Enable to email notification events to organization admins/editors. The default is false, and does not send emails to organization admins/editors.
`enableExpireSoonOfferWorkflowNotification`	boolean	no	Enable to send workflow notifications when offers are expiring soon. The default is false, and does not send expire soon offer workflow notifications.
`enableWebhookNotification`	boolean	no	Enable the product whitelist for the webhook notification. The default is false, and allow all the products notifications sent via webhook.
`entityFieldOptions`	object	no	EntityFieldOptions is a read-only capability map keyed by EntityType. Set by the GetNotificationConfigInfo handler from the package constant EntityFieldOptionsByEntityType. Drives the FE's "+ Add dynamic recipient ▾ → Offer ▸" branch. Ignored on inbound (PATCH) requests.
`roleGroupOptionsByEntityType`	object	no	RoleGroupOptionsByEntityType is a read-only capability map keyed by EntityType. Set by the GetNotificationConfigInfo handler from the package constant RoleGroupOptionsByEntityType. Drives the FE's "+ Add dynamic recipient ▾ → Role Group ▸" branch. Ignored on inbound (PATCH) requests.
`supportSlackChannelID`	string	no	ID of slack channel for suger customer support
`webhookProductWhitelist`	array<string>	no	The product whitelist (suger Product Id) for the webhook notification. If the product is not in the whitelist, the notification will be sent via webhook.

OfferFillerConfigInfo fields:

Field	Type	Required
`from`	Partner	no
`mappingInfo`	OfferFillerFieldMappingInfo	no
`targetObject`	OfferTargetObject	no
`to`	Partner	no

OrganizationConfigInfo fields:

Field	Type	Required	Description
`aiConfig`	AIConfig	no
`auth0ApplicationClientId`	string	no	The Client ID of the custom auth0 application. This is used to allow login with the custom SSO.
`auth0EnterpriseConnectionName`	string	no	The auth0 connection name which is used for Identity Provider (IdP) Initiated SSO
`auth0OrganizationId`	string	no	Auth0 Organization ID when using Auth0 Organizations (new SSO configuration)
`authProvider`	AuthProvider	no
`enableProductWhitelist`	boolean	no	Enable the product whitelist for the organization.
`enableReseller`	boolean	no	Whether to enable reseller (CPPO-in) UI for the organization. When false (default), all "As Reseller" toggles, "Show Resale" toggles for CPPO-in products, and the "Received" tab on the Resale page are hidden. When true, the organization can act as a reseller and create CPPO-in offers.
`enableSalesforceAwsFieldMappingV2`	boolean	no	Whether to use new filler filed mapping
`enableSugerHookTrigger`	boolean	no	Whether to enable Suger hook trigger
`enforceCustomLogin`	boolean	no	Whether to enforce the custom SSO login via the custom auth0 application. If true, the user can only login via the custom auth0 application. If false, the user can login via the custom auth0 application, or the default Suger auth0 application.
`productWhitelist`	array<string>	no	The product whitelist for the organization.

500 — Internal server error

Content-Type: application/json

View as Markdown · Interactive API reference

Spotted something wrong or out of date on this page? Tell us and we'll correct it.