List the journeys assigned to partners

GET https://api.suger.cloud/ai/org/{orgId}/prm/journeyAssignment

List the onboarding and enablement journeys assigned to this organization's partners, one row per assignment, with organization-wide counts in `totals` (active, completed and stalled; a stalled journey is also counted as active). Each row carries the partner's name (`partnerName`), the assignment `status`, `progress`, the `stalled` and `outdated` flags, and its `steps`: each step's `id` (the `stepId` TransitionJourneyStep takes), `type`, `title`, `status`, `dueAt`, and who completed it and when. The list also holds journeys another organization assigned to this one, and `totals` counts them: on those rows `organizationId` is not this organization, `partnerName` is the organization that assigned it, and TransitionJourneyStep answers 404 for them. For this organization's own partners, keep the rows whose `organizationId` is this organization. Use it to answer "which partners are stuck in onboarding" or "which partners have a journey step overdue". A step is overdue when its status is not DONE and its `dueAt` has passed; step statuses are NOT_STARTED, IN_PROGRESS and DONE. An assignment is ACTIVE, COMPLETED or ARCHIVED, and it is stalled (the STALLED filter value) when it is ACTIVE and has not been updated for 7 days. `outdated` means its journey template has changed since it was assigned. Filter with `partnershipId` (the `id` of a ListPrmPartnerships row), `statuses` (comma-separated, such as ACTIVE,STALLED), `templateId` or `search` (text in the partner's or the journey's name, case-insensitive). Computed values (`partnerName`, `stalled`, `progress`, `steps`) cannot be filtered with `q`; use `search` and `statuses` for them. ARCHIVED assignments are left out unless `includeArchived` is true or ARCHIVED is in `statuses`. A call returns 10 rows unless `limit` says otherwise (at most 200; a larger `limit`, up to 1000, returns only 200 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. For one assignment, send its `id` as `assignmentId`: the list answers that one row, ARCHIVED included, or none when it is not this organization's to see.

Parameters

NameInTypeRequiredDescription
orgId path string yes Organization ID
partnershipId query string no Only this partnership's journeys (the `id` of a ListPrmPartnerships row)
statuses query string no Multi-select status filter, comma-separated (e.g. ACTIVE,STALLED)
templateId query string no Template filter
search query string no Partner name contains
includeArchived query boolean no Include archived (when no status filter)
assignmentId query string no Only this assignment (a row's `id`). Includes it when ARCHIVED unless `statuses` leaves it out.
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 descending
limit query integer no Rows to return (default 10, at most 200; a larger value, up to 1000, returns only 200 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: JourneyDashboardResponse

JourneyDashboardResponse fields:

FieldTypeRequiredDescription
data array<JourneyAssignmentDetail> no
page_number integer no
page_size integer no
total_count integer no
totals JourneyDashboardTotals no

JourneyAssignmentDetail fields:

FieldTypeRequiredDescription
archivedAt string no
assignedAt string no
assignedByUserId string no
completedAt string no
createTime string no
description string no
estimatedDays integer no
id string no
lastUpdateTime string no
name string no
organizationId string no
outdated boolean no
partnerName string no PartnerName is the assignee partnership's display name (Info.Name), populated by the org-wide list so each journey row shows its assignee without a separate partners fetch. Empty when not resolved.
partnershipId string no
progress JourneyProgress no
sequential boolean no
stalled boolean no
status string no
steps array<JourneyStepView> no
templateId string no
templateVersion integer no TemplateVersion is the template revision this assignment was built from; Outdated is true when the template has since advanced past it (drift).
tierOutcome string no
tierOutcomeInfo PartnerTier no
version integer no
viewerPartnershipId string no ViewerPartnershipID is the partnership row the CURRENT viewer should open to reach the relationship's detail page. For the owning ISV it's the same as PartnershipID; for a partner-side read it's the partner's OWN mirror row (org = partner, partner_org_id = ISV), since the partner can't open the ISV-owned PartnershipID. Empty when no viewer-side row exists.
kind string no — TIER on a "Path to <tier>" journey.
renewalDeadline string no — set while this tier journey renews the partner's tier.
renewalFiscalYearStart string no — the fiscal-year start a renewal last restarted this tier journey for; kept once the renewal is done (renewalDeadline is then cleared). Absent if the journey was never renewed.

JourneyDashboardTotals fields:

FieldTypeRequiredDescription
active integer no
completed integer no
stalled integer no

JourneyProgress fields:

FieldTypeRequiredDescription
completed integer no
completedRequired integer no
total integer no
totalRequired integer no

JourneyStepView fields:

FieldTypeRequiredDescription
agreementId string no AgreementID links a SIGN_AGREEMENT step to the partner_agreement created for it at assign time, so executing THAT agreement completes THIS step. Empty when auto-create was skipped/failed — then the step completes on any executed agreement (the pre- match-by-type fallback).
completedAt string no
completedByUserId string no
ctaLabel string no
ctaUrl string no
description string no
dueAt string no
dueRemindersSent array<integer> no DueRemindersSent lists the EXPIRE_SOON.JOURNEY lead-day thresholds (e.g. 7, 1) already reminded for this step, so the daily journey cron sends each threshold's reminder at most once. Cleared when the step is reopened via applyStepStatus (a re-completion cycle re-arms the reminders only if the due date is still ahead).
id string no
internalNotes string no
locked boolean no
order integer no
refId string no course / certificate id
refName string no RefName is the display name of the referenced course / certificate, snapshotted at assign time so the partner (a different org) can show it without resolving the ISV's course / certificate ids.
required boolean no
status string no
targetCount integer no REGISTER_DEAL EARN_CERTIFICATION with People needed (the people).
taskId string no CUSTOM_TASK linked partnership_task
taskNames array<string> no TaskNames lists the task titles from the referenced task template (CUSTOM_TASK), snapshotted at assign time so both views can show every task the template defines, not just the first.
templateStepId string no TemplateStepID links back to the JourneyTemplateStep.ID this step was snapshotted from, so a reassign can match progress across template edits. Empty for assignments created before this field existed.
title string no
type string no
section string no — the step's heading (Delivery, Revenue, Marketing...).
autoComplete boolean no — a metric step; it completes itself and nobody ticks it.
dealValue JourneyDealValueConfig no
marketingPoints JourneyMarketingPointsConfig no
progress JourneyStepProgress no

PartnerTier fields:

FieldTypeRequiredDescription
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".

JourneyDealValueConfig fields:

FieldTypeRequiredDescription
measure string no VALUE (default, the deal value in the period) | COUNT (the number of deals, all time).
atLeast number no
dealKinds array<string> no SOURCED | CO_SOLD | CLOSED_WON.
dateField string no CLOSE | REGISTERED | CREATED.
period string no FISCAL_YEAR | FISCAL_QUARTER | TRAILING_12_MONTHS | CUSTOM.
start string no
end string no
source string no FOURS | SALESFORCE.
salesforce JourneySalesforceDealValue no

JourneyMarketingPointsConfig fields:

FieldTypeRequiredDescription
points integer no
period string no

JourneyStepProgress fields:

FieldTypeRequiredDescription
current number no
target number no
windowStart string no Start of the counting period (inclusive).
windowEnd string no End of the counting period (exclusive) — the window is [windowStart, windowEnd).
computedAt string no
error string no

JourneySalesforceDealValue fields:

FieldTypeRequiredDescription
object string no Always Opportunity (omitted means Opportunity).
valueField string no
dateField string no
filters array<JourneySalesforceFilter> no

JourneySalesforceFilter fields:

FieldTypeRequiredDescription
field string no
operator string no EQ | NEQ.
value string no

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/journeyAssignment' \
  -H "Authorization: Bearer $SUGER_TOKEN"

Response — 200

{
  "data": [
    {
      "archivedAt": "string",
      "assignedAt": "string",
      "assignedByUserId": "01H0000000000000000000",
      "completedAt": "string",
      "createTime": "2026-01-31T12:00:00Z",
      "description": "string",
      "estimatedDays": 1,
      "id": "01H0000000000000000000",
      "lastUpdateTime": "2026-01-31T12:00:00Z",
      "name": "Acme Corp",
      "organizationId": "01H0000000000000000000",
      "outdated": true
    }
  ],
  "page_number": 1,
  "page_size": 1,
  "total_count": 1,
  "totals": {
    "active": 1,
    "completed": 1,
    "stalled": 1
  }
}

View as Markdown · API reference overview

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