Pactly Public API v2 (in development) (2.0.0-draft)

List contracts allowed by the API-key owner current ACL, newest first. Scopes can narrow this access.

Results are cursor-paginated: pass the cursor from a response back to fetch the next page and stop when hasMore is false. The cursor encodes the sort position and is opaque — do not build one.

Filters combine with AND. party and counterparty both narrow by the parties linked to a contract: party takes a party id from GET /v2/parties, counterparty matches a name and is the convenience form. Property values filter as property[<key>]=<value> using a key from GET /v2/properties; an unknown key is rejected rather than ignored.

Supply up to 50 contract IDs from discovery. Returns bounded current-source citations, indexing coverage and continuation. Ranked search is not exhaustive.

Generate a new contract from a template.

values is a flat map keyed by the variable, valuemap and party ids from GET /v2/templates/{id}: a scalar for a variable, the chosen label (an array of labels for a multi-selection valuemap) for a valuemap, and an object of the declared attributes for a party. An unknown key, a wrong type, an unknown label or a missing required value is a 400 naming what is wrong. A value that is not supplied renders as [●].

options.persist (default true) decides whether Pactly keeps the contract. Persisted contracts are returned as a record you then fetch with GET /v2/contracts/{id}/download; ephemeral ones ("persist": false) keep nothing — no contract, no file, no audit event — and the document comes back base64-encoded in the response.

options.triggerWorkflows defaults to the value of persist and sends real email to real people, so turn it off for a bulk import. It cannot be enabled without persisting: a workflow has no contract to act on.

Retrieve detailed information about a specific contract including all properties, metadata, and status information.

Set up to 20 property values on a contract the key owner can edit, keyed by property key. Keys must exist in the company property catalogue, including global properties (see GET /v2/properties), and can be added to the contract. Conditional list choices use the resulting parent value; blank numeric strings are rejected. Concurrent writes retry or return 409. Dates take YYYY-MM-DD; null clears a value. Runs with the key owner's current permissions and has the same effect as editing the value in Pactly, including the renewal schedule. Requires the contracts:write scope.

Set the status of a contract the key owner can edit, by code or label from GET /v2/contract-statuses. Same as Change status in Pactly: no workflow transitions run. Requires the contracts:write scope and the owner's permission to change status.

Extract and return the full text content of a contract. Useful for search, analysis, and AI processing.

Download a contract file by ID

Retrieve all available contract templates that can be used to create new contracts.

Retrieve detailed information about a specific template including variables and value mappings.

List all emails associated with contracts (for AI training)

Retrieve all contract property definitions available to the company, including system default properties.

Retrieve a single property definition by its ID or unique key.

Retrieve all contract categories available to the company, including system default categories.

List the parties (counterparties, entities and individuals) in the contact book. Excludes parties still awaiting confirmation — an AI-extracted party a person has not accepted is a suggestion, not a counterparty — and soft-deleted parties.

keyword matches the normalised search string, so "ASTAR" finds "A*STAR". Results are cursor-paginated: pass the cursor from a response back to fetch the next page, and stop when hasMore is false. A cursor is opaque and must not be constructed by hand.

The custom attribute definitions for parties. A party carries its values in customAttributes keyed by the key returned here, the same way a contract pairs its property values with GET /v2/properties.

Get a single party by id.

List the clause library — the pre-approved language an agent should propose instead of drafting its own.

Visibility follows the key owner: an admin key sees the whole library, a grouped user sees their groups, and a key owned by a lite user is refused, because lite users have no Clause Bank.

List the playbooks in force — your negotiation positions as structured data. Returns your own playbooks and any Pactly-provided default you have not switched off; isDefault tells them apart. Only production versions are returned, because a draft is not policy.

Positions are omitted here; fetch one playbook to get them.

A playbook with its positions: keywords, fallback language, and what a missing clause means for each position (ifNotFound).

Positions still awaiting human confirmation are excluded — an AI-suggested position is not policy until someone accepts it — and counted in unconfirmedPositionCount. Position notes are limited to drafting guidance; internal rationale and escalation routing are not published.

Report which playbook position keywords appear in a document, and where.

This is keyword matching, not a compliance review. It returns no verdict on whether a position is met — deciding that is a separate AI evaluation. Use the matches, each position's fallback language and its ifNotFound setting to reach your own conclusion.

Send paragraphs as an array of strings, exactly the shape GET /v2/contracts/{id}/text returns. Nothing is persisted: no review, no round, no change to the contract.

Test endpoint to test API connectivity and authentication