List Partnership Tasks

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

List the tasks this organization tracks with its partners. Each task belongs to one partnership (`partnershipId`) and has a `title`, a `status` (OPEN, IN_PROGRESS, BLOCKED, COMPLETED), a `priority` (URGENT, HIGH, NORMAL, LOW), a `dueAt`, its assignees and a `direction`: OUTBOUND for a task this organization shared with the partner, INBOUND for one the partner shared with it. Filter with `q`, a LISP expression over the task's fields: `(= partnershipId "<id>")` for one partner (the partnership id from ListPrmPartnerships), `(= status "BLOCKED")`, or both inside `(and...)`. Set `tab` to `mine` with `assigneeUserId` for one user's tasks. 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 task with its subtasks, call GetPartnershipTask.

Parameters

NameInTypeRequiredDescription
orgId path string yes Organization ID
tab query string no Tab: all (default), mine, or marketingPoints. Marketing points requests are listed only with marketingPoints; every other tab leaves them out.
assigneeUserId query string no Assignee user id (required when tab=mine)
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: ListBaseResponse-PartnershipTaskListItem

ListBaseResponse-PartnershipTaskListItem fields:

FieldTypeRequiredDescription
data array<PartnershipTaskListItem> 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.

PartnershipTaskListItem fields:

FieldTypeRequiredDescription
assignedSide string no OUTBOUND, INBOUND, or BOTH — which side does the work. Stored verbatim on both mirror rows (not flipped).
assigneeUserIds array<string> no User IDs assigned to this task on this side.
category string no Set from template.category at materialization; null otherwise
completedAt string no Set when status moves to COMPLETED; cleared on reopen
cppoOfferId string no Optional link to workload.offer.id (must be CPPO-typed and share partnership)
createTime string no Creation timestamp
createdByUserId string no Creator's user id. NULL on mirror rows (partner org has no real creator user).
createdByUserName string no Display name of the creator — both mirror rows carry the same value
description string no Optional free-form description
direction string no OUTBOUND or INBOUND.
dueAt string no Target due date
id string no ID of the ent. Unique partnership task identifier (UUID)
info PartnershipTaskInfo no
lastUpdateTime string no Last update timestamp
organizationId string no ISV org id — tenant isolation
partnerName string no PartnerName is the resolved partnership.info.name for PartnershipID. Empty when the partnership can't be loaded (deleted / cross-org); the client falls back to a truncated id in that case.
partnershipId string no
priority string no URGENT, HIGH, NORMAL, LOW.
referralId string no Optional link to cosell.referral.id — validated to share partnership at write time
status string no OPEN, IN_PROGRESS, BLOCKED, COMPLETED.
tags array<string> no Free-form tag strings.
taskPairId string no Shared UUID that links the two mirror rows across a partnership
templateId string no Optional provenance link to prm.partnership_task_template.id — snapshot semantics
title string no Task title
version integer no Optimistic-concurrency counter; bumped on every write

PartnershipTaskInfo fields:

FieldTypeRequiredDescription
autoAssignUnresolved boolean no AutoAssignUnresolved is set when a role-based assignee was requested at create time but resolved to no one on either side. The task may still carry fixed assignees from the request; the UI shows the "no matching contact" warning badge only while the row has no assignees. On the partner-side mirror row the flag is set only for external roles; resolution FAILURES (as opposed to a genuine no-match) leave it unset.
journeyAssignmentId string no JourneyAssignmentID / JourneyStepID link a task materialized from a journey CUSTOM_TASK step back to that step. Set only on journey tasks; drives the "Journey task" badge and the bidirectional step↔task completion sync. Stored here (not as columns) to avoid a partnership_task migration.
journeyStepId string no
resources array<PartnershipTaskResource> no
subtasks array<PartnershipSubtask> no
marketingPoints MarketingPointsRequest no

PartnershipTaskResource fields:

FieldTypeRequiredDescription
attachedByOrgId string no AttachedByOrgID records which org's user attached this resource. The PATCH path uses it to enforce per-attacher delete: only the org that attached a resource may remove it. Empty values are treated as source-side-owned by the update validator (legacy rows from before this field existed); only the source org can prune them.
displayName string no
externalUrl string no
file PartnershipTaskResourceFile no
kind string no
partnerFileId string no

PartnershipSubtask fields:

FieldTypeRequiredDescription
assigneeUserId string no AssigneeUserID is the org-local user assigned to this subtask. Per-side: each mirror row carries its own value and it is not synced across the partnership pair.
completedAt string no CompletedAt is stamped by the server when a subtask is saved with status == COMPLETED and CompletedAt is nil, so clients can just flip the status and let the server handle the timestamp.
priority string no
status string no
title string no

MarketingPointsRequest fields:

FieldTypeRequiredDescription
activityTypeId string no
activityName string no
points integer no
activityDate string no
journeyAssignmentId string no
journeyStepId string no

PartnershipTaskResourceFile fields:

FieldTypeRequiredDescription
available boolean no
name string no
sizeBytes integer no
type 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/partnershipTask' \
  -H "Authorization: Bearer $SUGER_TOKEN"

Response — 200

{
  "data": [
    {
      "assignedSide": "string",
      "assigneeUserIds": [
        "01H0000000000000000000"
      ],
      "category": "string",
      "completedAt": "string",
      "cppoOfferId": "01H0000000000000000000",
      "createTime": "2026-01-31T12:00:00Z",
      "createdByUserId": "01H0000000000000000000",
      "createdByUserName": "Acme Corp",
      "description": "string",
      "direction": "string",
      "dueAt": "string",
      "id": "01H0000000000000000000"
    }
  ],
  "page_number": 1,
  "page_size": 1,
  "total_count": 1,
  "total_count_capped": true
}

View as Markdown · API reference overview

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