# List Partner Agreements

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

List partner agreements, newest first, each with its `type` (NDA, MSA, REFERRAL_AGREEMENT, SOW, OTHER), `status` (DRAFT, AWAITING_SIGNATURE, PARTIALLY_SIGNED, FULLY_EXECUTED, EXPIRED), effective and expiry dates, attached files and `version`. Without `partnershipId` the list holds only the agreements this organization sent, across all partners. Pass `partnershipId` (a partnership id from ListPrmPartnerships) for one partner's agreements, including those the partner sent. The sender is the row's `organizationId`, and only the sender can change an agreement's status. Deleted agreements are not returned.

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, and filter with `q`, such as `(= status "AWAITING_SIGNATURE")`. To change an agreement's status, call UpdatePartnerAgreement.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `orgId` | path | string | yes | Organization ID |
| `partnershipId` | query | string | no | Partnership ID to scope the list to |
| `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 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-PartnerAgreement`

**`ListBaseResponse-PartnerAgreement`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | array<PartnerAgreement> | 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. |

**`PartnerAgreement`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `attachments` | array<PartnerAgreementAttachment> | no | File attachments with role labels (TEMPLATE, SIGNED_PARTY_A, COUNTERSIGNED, FINAL_EXECUTED, AMENDMENT). |
| `createTime` | string | no | Creation timestamp |
| `createdByUserId` | string | no | Creator's user id |
| `createdByUserName` | string | no | Display name of the creator |
| `deletedAt` | string | no | The time it was deleted; empty while it is active. |
| `effectiveDate` | string | no | Date the agreement takes effect |
| `expiryDate` | string | no | Date the agreement expires |
| `id` | string | no | ID of the ent. Unique partner agreement identifier (UUID) |
| `lastUpdateTime` | string | no | Last update timestamp |
| `name` | string | no | Agreement display name, e.g. "Acme ↔ Globex NDA" |
| `organizationId` | string | no | Sending/owner org id — the org that created the agreement. Tenant isolation; only this org may change status/stages or delete. |
| `partnershipId` | string | no | The two parties (sender + counterpart) are derived from this partnership at query time. |
| `status` | string | no | DRAFT, AWAITING_SIGNATURE, PARTIALLY_SIGNED, FULLY_EXECUTED, EXPIRED. |
| `type` | string | no | NDA, MSA, REFERRAL_AGREEMENT, SOW, OTHER. |
| `version` | integer | no | Optimistic-concurrency counter; bumped on every write |

**`PartnerAgreementAttachment`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `fileId` | string | no | FileID is the UUID allocated by the upload step (PartnerFileUploadRef.FileID). |
| `fileName` | string | no | FileName is the original upload file name. |
| `role` | string | no | Role is one of PartnerAgreementAttachmentRoles. |
| `s3Key` | string | no | S3Key points at the uploaded object in the org-file bucket. The bucket itself is resolved internally at download time (org-file bucket), so it is not stored per-attachment. |
| `sizeBytes` | integer | no | SizeBytes is the uploaded object size. |
| `uploadTime` | string | no | UploadTime is when the attachment was added to the agreement. |
| `uploadedByUserId` | string | no | UploadedByUserID / UploadedByUserName identify the uploader (resolved from auth). |
| `uploadedByUserName` | 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](https://doc.fours.com/settings/oauth-app/)._

### Request

```bash
curl -X GET 'https://api.suger.cloud/ai/org/{orgId}/prm/agreement' \
  -H "Authorization: Bearer $SUGER_TOKEN"
```

### Response — 200

```json
{
  "data": [
    {
      "attachments": [
        {
          "fileId": "01H0000000000000000000",
          "fileName": "Acme Corp",
          "role": "string",
          "s3Key": "string",
          "sizeBytes": 1,
          "uploadTime": "2026-01-31T12:00:00Z",
          "uploadedByUserId": "01H0000000000000000000",
          "uploadedByUserName": "Acme Corp"
        }
      ],
      "createTime": "2026-01-31T12:00:00Z",
      "createdByUserId": "01H0000000000000000000",
      "createdByUserName": "Acme Corp",
      "deletedAt": "string",
      "effectiveDate": "2026-01-31T12:00:00Z",
      "expiryDate": "2026-01-31T12:00:00Z",
      "id": "01H0000000000000000000",
      "lastUpdateTime": "2026-01-31T12:00:00Z",
      "name": "Acme Corp",
      "organizationId": "01H0000000000000000000",
      "partnershipId": "01H0000000000000000000"
    }
  ],
  "page_number": 1,
  "page_size": 1,
  "total_count": 1,
  "total_count_capped": true
}
```

---

API reference: https://doc.fours.com/api/
