API template library

Simulate the DocuSign Agreement Manager API

A WireMock simulation of DocuSign's REST API — covering AI-extracted agreements with provisions, parties and review status, OData-style filtering and search, agreement types, standard and custom provisions, and bulk upload jobs.

Vendor
DocuSign
Functionality
Agreements, provisions, filtering, bulk upload
Spec version
1.0.0
Endpoints
16
Stubs
132
Protocol
REST
Validation
AI-validated Before publication, an AI agent exercised these endpoints against the real DocuSign API through WireMock's recording proxy, and the recorded traffic was used to verify each stub's request and response shapes.

Live sandbox · no signup, no API key

DocuSign Agreement Manager API

A running WireMock Cloud instance of this template, callable right now from a terminal, a script, or an AI agent.

Base URL
https://ldqvle.wiremockapi.cloud

GET List agreements, newest first

curl -s -X GET 'https://ldqvle.wiremockapi.cloud/v1/accounts/2f5a7c9e-1b3d-4f6a-8c2e-4a6b8d0f2a41/agreements?limit=5' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

GET Filter agreements by total value

curl -s -X GET 'https://ldqvle.wiremockapi.cloud/v1/accounts/2f5a7c9e-1b3d-4f6a-8c2e-4a6b8d0f2a41/agreements?%24filter=provisions%2Ftotal_agreement_value%20gt%20100000' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

GET List the standard agreement types

curl -s -X GET 'https://ldqvle.wiremockapi.cloud/v1/accounts/2f5a7c9e-1b3d-4f6a-8c2e-4a6b8d0f2a41/agreement-types' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Method Path Summary
GET /v1/accounts/{accountId}/agreement-types List configured agreement types for the account
POST /v1/accounts/{accountId}/agreement-types/actions/add Associate provisions with one or more agreement types
POST /v1/accounts/{accountId}/agreement-types/actions/remove Disassociate provisions from one or more agreement types
GET /v1/accounts/{accountId}/agreements Retrieve a list of agreements
PATCH /v1/accounts/{accountId}/agreements Update an agreement by locating it via document ID
DELETE /v1/accounts/{accountId}/agreements/{agreementId} Delete a specific agreement
GET /v1/accounts/{accountId}/agreements/{agreementId} Retrieve detailed information about a specific agreement
PATCH /v1/accounts/{accountId}/agreements/{agreementId} Update specific fields of an agreement
PATCH /v1/accounts/{accountId}/agreements/{agreementId}/actions/change-type Change the type of an agreement
DELETE /v1/accounts/{accountId}/custom-provisions Delete one or more custom provision definitions
GET /v1/accounts/{accountId}/custom-provisions List provision definitions for an account
PATCH /v1/accounts/{accountId}/custom-provisions Update one or more custom provision definitions
POST /v1/accounts/{accountId}/custom-provisions Create a custom provision definition
POST /v1/accounts/{accountId}/upload/jobs Create bulk job
GET /v1/accounts/{accountId}/upload/jobs/{jobId} Get bulk job status
POST /v1/accounts/{accountId}/upload/jobs/{jobId}/actions/complete Mark bulk job upload as complete

Unauthenticated WireMock Cloud demo sandbox for DocuSign — not an official DocuSign sandbox, and it returns simulated example data only.

What's inside the Agreement Manager template

Agreement Manager is the repository behind DocuSign Navigator, where signed contracts become structured records. Lucky Shrub Sales starts with five, from a completed Acme master services agreement to a statement of work still pending review. Each record pairs a summary and parties list with a provisions object (effective and expiration dates, an ISO 8601 term such as P6M, total value with its currency, payment terms, governing law), and values that were never extracted come back as explicit nulls wherever the spec marks a field nullable, so null handling gets exercised rather than skipped.

  • Agreements — list, search, read, update, change type and delete, with linked Salesforce data on request
  • Filtering — field filters with [gt], [ge], [lt] and [le] comparisons, an OData $filter of up to three clauses, and $search
  • Agreement types — the 49 standard types, with add and remove actions per account
  • Provisions — 14 standard provisions mapped to the agreement types they apply to, plus custom provisions
  • Bulk upload jobs — create a job with per-document upload URLs, complete it to produce agreements, and poll its status

DocuSign Agreement Manager mock API FAQ

Up to three clauses joined by and, each an eq, gt, ge, lt or le comparison, an in list, or contains(). Numbers compare numerically, so provisions/total_agreement_value gt 100000 returns the Acme master services agreement at 750,000 and the Greenleaf supply agreement at 180,000. ne, or, not, startswith and endswith answer 400 with a message listing the supported forms, matching the operators the spec marks unsupported.

The bracket operators are [gt], [ge], [lt] and [le]; [gte] and [lte] look plausible but aren't valid, and the mock rejects them with a 400 naming the four that are. The same four work on review_completed_at, the creation date, the three date provisions and term_length.

No. Upload URLs point at a placeholder host. Completing a job moves it to UPLOAD_COMPLETE, the next poll shows IN_PROGRESS and the one after COMPLETE, by which point each expected document, up to five, exists as an agreement titled after the job. That drives the polling loop faithfully without testing extraction quality.

You can, but the sandbox is shared, so an update or delete changes what the next visitor sees. Make destructive changes in your own WireMock Cloud copy instead; its Reset state brings all five agreements back. Accounts other than Lucky Shrub Sales start empty, and an unauthenticated call gets a 401 problem response.

Vendor names identify APIs represented by WireMock template sources. This page does not imply vendor endorsement, certification, partnership, or official integration status.