Pactly API Documentation

Pactly API Documentation

Welcome to the Pactly API documentation. The Pactly API provides programmatic access to contract management functionality, enabling you to integrate Pactly with your existing business systems and automate your contract workflows.

Overview

The Pactly API is a RESTful web service that allows you to:

API versions

V1 is stable. Its current request and response contract is frozen. New capabilities are developed in v2.

V2 is in development. It starts with the same endpoints and behavior as v1. More endpoints and changes to requests and responses are coming before v2 is declared stable.

The same API keys, headers and permissions work with both versions. Select the version in the URL: /v1/contracts or /v2/contracts. No key rotation or account migration is needed. Use v1 if your integration needs a frozen contract.

Getting Started

To use the Pactly API, you'll need:

  1. API Key - Contact your Pactly administrator to obtain an API key for your organization
  2. API Endpoint - Use the production endpoint:
    • Production: https://clientapi.pactly.ai
    • UAT: https://uat-api.pactly.com

Authentication

The Pactly API uses API key authentication. Include your API key in the x-api-key header of all requests:

x-api-key: YOUR_API_KEY

Contract Types

Pactly manages three types of contracts, all accessible through the same API endpoints:

Response Format

Data endpoints return JSON. Downloads return the requested document. Contracts use id and a type of template, playbook or external. List responses include a pagination object; follow its cursor to retrieve the next page.

Contract lists return status as {"code": 5, "label": "Executed"}. Detail responses preserve the configured status value. Use the endpoint's reference schema for its exact response.

Rate Limiting

API requests are subject to rate limiting to ensure service stability. Current limits will be communicated when you receive your API key.

Support

For API support, please contact:

V2 development

Follow the v2 reference for new endpoints and changes. V2 can change while it is in development. V1 remains available alongside it.

Ready to get started? Check out the API Reference for detailed endpoint documentation and interactive examples.