List Partner Relationships
GET https://api.suger.cloud/ai/org/{orgId}/prm/partnership
List the partner companies this organization has a relationship with, one row per partnership, with filtering, sorting and pagination. Each row carries the partner's name and website, the relationship and engagement type, the assigned partner manager, the tier, the status, and aggregate figures Fours computes (revenue to date, deal count). Start here to answer "who are our partners", to find a partner by name or attribute, or to obtain the partnership id (its `id`) that the other partnership operations take as `partnershipId`. Use the `q` filter for a targeted search when the list is large. This lists partnerships, not invitations: a company that has been invited but has not accepted yet appears in ListPrmInvitations, not here. For one partner's full record including contacts and portal view, call GetPrmPartnership. `q` can filter on fields inside `info` by dotted path. To find the partner a Slack channel is linked to (Settings → Partners → Slack channel mapping), pass `q=(= info.slackChannelId "C0123456789")` with the channel id; exactly one row comes back when the channel is mapped, none when it is not. A call returns 10 rows unless `limit` says otherwise (at most 100; a larger `limit`, up to 1000, returns only 100 rows and sends `offset` to the wrong page, and one over 1000 is refused): page by sending `limit` on every call with `offset` a multiple of it (0, `limit`, twice `limit`,...) until you have `total_count` rows.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | yes | Organization ID |
q | query | string | no | Filter: a LISP expression over the row's stored fields, written (= field "value"); combine conditions with (and...) |
s | query | string | no | Sort field (prefix with - for desc) |
ss | query | string | no | Sort style: json for typed sort |
limit | query | integer | no | Rows to return (default 10, at most 100; a larger value, up to 1000, returns only 100 rows and sends `offset` to the wrong page; over 1000 is refused) |
offset | query | integer | no | Rows to skip, a multiple of `limit` and sent together with it |
Responses
200 — OK
Content-Type: application/json · Schema: ListBaseResponse-Partnership
ListBaseResponse-Partnership fields:
| Field | Type | Required | Description |
|---|---|---|---|
data | array<Partnership> | no | |
page_number | integer | no | |
page_size | integer | no | |
total_count | integer | no | TotalCount is the number of matching rows, counted up to ListCountCap. When TotalCountCapped is true it is that cap rather than the real total. |
total_count_capped | boolean | no | TotalCountCapped reports that more rows match than TotalCount says: the count stopped at ListCountCap because an exact total costs a full scan of everything the filter matches. Clients should present TotalCount as a lower bound ("10,000+") when this is set. Omitted when false, so clients that predate the field are unaffected. |
Partnership fields:
| Field | Type | Required | Description |
|---|---|---|---|
companyId | string | no | The partner's company ID from identity.buyer.company_id, used to group buyers across channels |
createTime | string | no | Creation timestamp |
domain | string | no | Lowercased email domain of the partner (the OTHER side of the relationship). Used for dedup/lookup when provisioning partnerships from inbound flows where the partner has no Fours org and no engagement_id pairing exists. |
globalCompanyId | string | no | Links partnership to canonical company record for firmographic data |
id | string | no | ID of the ent. Unique partnership identifier (UUID) |
info | PartnershipInfo | no | |
lastActivityTime | string | no | Most recent activity timestamp (e.g., latest CPPO transaction), updated by sync job |
lastUpdateTime | string | no | Last update timestamp |
organizationId | string | no | The org that owns this partnership record (seller) |
partnerManager | string | no | |
partnerOrgId | string | no | The partner's own Fours org ID (nullable if partner is not a Fours org) |
partnerTypes | array<string> | no | Types of partner: RESELLER, SI (System Integrator), ISV, OTHER |
partnershipSince | string | no | When the partnership was established (e.g., first CPPO transaction date) |
status | AiStatus | no |
PartnershipInfo fields:
| Field | Type | Required | Description |
|---|---|---|---|
aiOverview | PartnershipAiOverview | no | |
buyerIds | array<string> | no | BuyerIDs lists the Fours internal buyer IDs grouped under this partnership. Used by frontend to query CPPO offers via the existing offer API. |
channels | array<string> | no | Channels lists the cloud marketplaces this partner operates on (e.g., ["AWS", "AZURE"]). |
crmAccountInfo | CrmAccountInfo | no | |
crmPartnerChampion | AiPartnerChampionContact | no | |
crmPartnerManager | CrmPartnerManager | no | |
customCommissionPlanId | string | no | Empty/unset means "use Standard Defaults". The share-cosell flow uses this to prepopulate Revenue Share fields per commission type at deal-create time. |
description | string | no | Description is a brief partner summary |
displayName | string | no | DisplayName is the name the ISV chose to show for this partner. Written only by the partner PATCH: discovery sync and the partner org's Company Name propagation write Name and never touch it. When it has text the console shows it instead of Name (see ShownName). |
employees | string | no | Employees is the partner's employee count as a string, derived from enriched company info. |
engagementType | EngagementType | no | |
founded | string | no | Founded is the partner's founding year, derived from enriched company info. |
globalCompanyContactIds | array<string> | no | |
location | string | no | Location is the partner's location (e.g., "Dover, Delaware"), derived from buyer company info. |
matchingAccounts | array<MatchingCrmAccount> | no | MatchingAccounts lists the CRM accounts whose domain matches the partner's managed accounts. Only populated for partnerships with SUGGESTED status. |
name | string | no | Name is the partner's display name, derived from the buyer with the most complete data. |
ourTier | PartnerTier | no | |
ourTierActivityTypes | array<TierActivityType> | no | , read time only, beside ourTier. The partner org's marketing activity list, what Earn points offers in its program. Left out when it has none. |
ourTierSince | string | no | , read time only, beside ourTier. When the partner org set ourTier (its own row's partnerTierSince). |
partnerBrand | PartnerBrand | no | |
partnerChampionContact | AiPartnerChampionContact | no | |
partnerTier | string | no | PartnerTier is the ID of the tier this partner is assigned in the owning org's ISV-defined tier hierarchy. References a PartnerTier.ID in the org's PartnershipConfigInfo.Tiers. Set to the default tier when the partnership is created. Empty means "fall back to the org's default tier" at read time (e.g. a tier was deleted). |
partnerTierSince | string | no | . When partnerTier last changed. |
partnerViewTemplateId | string | no | Empty/unset means "fall back to the org's Default Template" at render time. |
potentialRevenue | number | no | PotentialRevenue is the total opportunity amount from matching CRM accounts. Only populated for partnerships with SUGGESTED status. |
recommendationReason | string | no | RecommendationReason is an AI-generated human-readable explanation of why this partner is recommended. Only populated for partnerships with SUGGESTED status. |
recommendationScore | number | no | RecommendationScore is a normalized score (0.0–1.0) indicating how good a match this partner is for the ISV. Only populated for partnerships with SUGGESTED status. |
relationshipType | RelationshipType | no | |
revenueByChannel | object | no | RevenueByChannel is revenue broken down by cloud channel and YYYY-MM period. Example: {"AWS": {"2026-01": 50000}, "AZURE": {"2026-02": 30000}}. |
scoreBreakdown | RecommendationScoreBreakdown | no | |
sellerIds | object | no | SellerIDs maps cloud partner to the partner's cloud-specific account ID. AWS -> AWS Account ID (12-digit), AZURE -> Azure MPO Seller ID. Used by frontend to pre-populate the reseller account field when creating CPPOs. |
slackChannelId | string | no | SlackChannelID is the Slack channel this partner's broadcasts / co-sell activity post to. Empty/unset ⇒ no channel configured. |
slackChannelName | string | no | SlackChannelName caches the channel's display name (e.g. "partner-cloudsync-suger"). |
sugerCosellMetrics | PartnershipSugerCosellMetrics | no | |
suggestedRelationshipType | RelationshipType | no | |
totalDeals | integer | no | TotalDeals is the total count of CPPO-related offers for this partner. |
totalRevenue | number | no | TotalRevenue is the sum of disbursed CPPO-attributed revenue for this partner. |
upcomingRevenue | number | no | UpcomingRevenue is the total CommitAmount from active CPPO_OUT offers minus disbursed revenue. |
PartnershipAiOverview fields:
| Field | Type | Required | Description |
|---|---|---|---|
cloudTier | string | no | CloudTier is the partner's cloud marketplace tier level. |
description | string | no | Description is a brief AI-generated summary of the partner company. |
employeeRange | string | no | EmployeeRange is the approximate employee count range (e.g., "100-500"). |
error | string | no | Error holds the error message if generation failed. |
foundedYear | string | no | FoundedYear is the year the company was founded. |
headquarters | string | no | Headquarters is the company's headquarters location (e.g., "San Francisco, CA, USA"). |
keyProducts | array<string> | no | KeyProducts lists the partner's key products or services. |
knownCustomers | array<string> | no | KnownCustomers lists notable customers of the partner. |
lastScraped | string | no | LastScraped is the timestamp of the last AI overview generation (RFC3339). |
retryCount | integer | no | RetryCount is the number of consecutive failed generation attempts for this partnership. The daily Sync Partnerships workflow caps retries at 3 and only retries after a 14-day backoff (see). |
specializations | array<string> | no | Specializations lists the partner's technical specializations. |
status | string | no | Status indicates the generation result: empty for success, "failed" or "empty" on error. |
targetIndustries | array<string> | no | TargetIndustries lists the industries the partner focuses on. |
website | string | no | Website is the partner's website URL as reported by AI. |
CrmAccountInfo fields:
| Field | Type | Required | Description |
|---|---|---|---|
accountId | string | no | AccountID is the CRM account/company record ID. |
accountName | string | no | AccountName is the display name of the CRM account. |
provider | string | no | Provider identifies which CRM the account belongs to ("SALESFORCE" or "HUBSPOT"). |
AiPartnerChampionContact fields:
| Field | Type | Required | Description |
|---|---|---|---|
contactId | string | no | ContactID is the CRM contact record ID. |
email | string | no | Email is the contact's email address. |
name | string | no | Name is the contact's full name. |
title | string | no | Title is the contact's job title. |
CrmPartnerManager fields:
| Field | Type | Required | Description |
|---|---|---|---|
email | string | no | Email is the CRM user's email, lowercased. |
name | string | no | Name is the CRM user's full name. |
status | CrmPartnerManagerStatus | no |
MatchingCrmAccount fields:
| Field | Type | Required | Description |
|---|---|---|---|
accountId | string | no | AccountID is the CRM account record ID. |
accountName | string | no | AccountName is the display name of the CRM account. |
domain | string | no | Domain is the normalized domain of the CRM account's website. |
opportunityAmount | number | no | OpportunityAmount is the total opportunity revenue from this account. |
opportunityCount | integer | no | OpportunityCount is the number of opportunities on this account. |
PartnerTier fields:
| Field | Type | Required | Description |
|---|---|---|---|
benefits | string | no | Benefits is a freeform benefits line shown to partners. |
color | string | no | Color is the badge color as a hex string, e.g. "#d4a017". |
description | string | no | Description is shown to partners in the portal. |
id | string | no | ID is a stable identifier referenced by PartnershipInfo.PartnerTier. Assignments survive tier renames/recolors because they key on ID. |
name | string | no | Name is the display label, e.g. "Gold". |
TierActivityType fields:
| Field | Type | Required | Description |
|---|---|---|---|
id | string | no | |
name | string | no | |
points | integer | no | |
description | string | no |
PartnerBrand fields:
| Field | Type | Required | Description |
|---|---|---|---|
bannerTagline | string | no | |
coverStyle | string | no | |
logoFileKey | string | no | |
logoSignedUrl | string | no | |
primaryColor | string | no | |
secondaryColor | string | no |
RecommendationScoreBreakdown fields:
| Field | Type | Required | Description |
|---|---|---|---|
accountScores | array<AccountMatchScore> | no | AccountScores holds per-matched-account scoring details. |
isSugerUser | boolean | no | IsSugerUser is true if the partner is a Fours customer. |
matchCount | integer | no | MatchCount is the number of CRM accounts that matched. |
rawScore | number | no | RawScore is the unnormalized sum of account scores. |
sugerUserBonus | number | no | SugerUserBonus is the additive bonus for being a Fours user. |
totalIsvAccounts | integer | no | TotalISVAccounts is the total number of ISV CRM accounts (used for normalization). |
400 — Bad request error
Content-Type: application/json
Example
Generated from this operation's schema. Values are placeholders —
substitute your own ids, and set SUGER_TOKEN to a bearer token
from the OAuth client-credentials exchange.
Request
curl -X GET 'https://api.suger.cloud/ai/org/{orgId}/prm/partnership' \
-H "Authorization: Bearer $SUGER_TOKEN" Response — 200
{
"data": [
{
"companyId": "01H0000000000000000000",
"createTime": "2026-01-31T12:00:00Z",
"domain": "string",
"globalCompanyId": "01H0000000000000000000",
"id": "01H0000000000000000000",
"info": {
"aiOverview": {
"cloudTier": "string",
"description": "string",
"employeeRange": "string",
"error": "string",
"foundedYear": "string",
"headquarters": "string",
"keyProducts": [],
"knownCustomers": [],
"lastScraped": "string",
"retryCount": 1,
"specializations": [],
"status": "string"
},
"buyerIds": [
"01H0000000000000000000"
],
"channels": [
"string"
],
"crmAccountInfo": {
"accountId": "01H0000000000000000000",
"accountName": "Acme Corp",
"provider": "string"
},
"crmPartnerChampion": {
"contactId": "01H0000000000000000000",
"email": "buyer@example.com",
"name": "Acme Corp",
"title": "string"
},
"crmPartnerManager": {
"email": "buyer@example.com",
"name": "Acme Corp",
"status": "MATCHED"
},
"customCommissionPlanId": "01H0000000000000000000",
"description": "string",
"displayName": "Acme Corp",
"employees": "string",
"engagementType": "RESELLER",
"founded": "string"
},
"lastActivityTime": "2026-01-31T12:00:00Z",
"lastUpdateTime": "2026-01-31T12:00:00Z",
"organizationId": "01H0000000000000000000",
"partnerManager": "string",
"partnerOrgId": "01H0000000000000000000",
"partnerTypes": [
"string"
]
}
],
"page_number": 1,
"page_size": 1,
"total_count": 1,
"total_count_capped": true
} Error — 400
"string" View as Markdown · API reference overview
Spotted something wrong or out of date on this page? Tell us and we'll correct it.