List Partnership Task Templates
GET https://api.suger.cloud/ai/org/{orgId}/prm/partnershipTaskTemplate
List this organization's partnership task templates: reusable sets of tasks the team applies to partnerships. No call applies a template in one step. To apply one, call CreatePartnershipTask once for each entry of its `info.tasks`, with `direction` OUTBOUND, the entry's title, description, priority, `assignedSide`, category and tags, its `defaultAssigneeUserIds` as `assigneeUserIds`, `dueAt` set to today plus its `defaultDueDays`, and the template's `id` as `templateId` on the first call. 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, and filter with `q`.
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 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-PartnershipTaskTemplate
ListBaseResponse-PartnershipTaskTemplate fields:
| Field | Type | Required | Description |
|---|---|---|---|
data | array<PartnershipTaskTemplate> | 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. |
PartnershipTaskTemplate fields:
| Field | Type | Required | Description |
|---|---|---|---|
createTime | string | no | Creation timestamp |
createdByUserId | string | no | Creator |
description | string | no | Optional free-form description of the template (the playbook this captures) |
id | string | no | ID of the ent. Unique template identifier (UUID) |
info | PartnershipTaskTemplateInfo | no | |
lastUpdateTime | string | no | Last update timestamp |
lastUsedAt | string | no | Set when the template is successfully assigned to a partnership |
name | string | no | Template name, unique per org (case-insensitive; enforced in handler) |
organizationId | string | no | ISV org id — templates are org-scoped |
version | integer | no | Optimistic-concurrency counter |
PartnershipTaskTemplateInfo fields:
| Field | Type | Required | Description |
|---|---|---|---|
tasks | array<PartnershipTaskTemplateTask> | no |
PartnershipTaskTemplateTask fields:
| Field | Type | Required | Description |
|---|---|---|---|
assignedSide | string | no | |
category | string | no | |
defaultAssigneeContactType | string | no | DefaultAssigneeContactType names a role (PartnershipTaskAssigneeContactType*) to auto-assign at task-creation time against the partner's live contacts. Empty = no role-based assignment. Additive to DefaultAssigneeUserIDs — role-resolved users are unioned into the task's assignees at create time. |
defaultAssigneeUserIds | array<string> | no | |
defaultDueDays | integer | no | |
description | string | no | |
priority | string | no | |
subtasks | array<PartnershipTaskTemplateSubtask> | no | |
tags | array<string> | no | |
title | string | no |
PartnershipTaskTemplateSubtask fields:
| Field | Type | Required | Description |
|---|---|---|---|
priority | string | no | |
title | 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/partnershipTaskTemplate' \
-H "Authorization: Bearer $SUGER_TOKEN" Response — 200
{
"data": [
{
"createTime": "2026-01-31T12:00:00Z",
"createdByUserId": "01H0000000000000000000",
"description": "string",
"id": "01H0000000000000000000",
"info": {
"tasks": [
{}
]
},
"lastUpdateTime": "2026-01-31T12:00:00Z",
"lastUsedAt": "string",
"name": "Acme Corp",
"organizationId": "01H0000000000000000000",
"version": 1
}
],
"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.