DocuSign

Agreements API

API for retrieving agreements

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

API for retrieving agreements

Endpoints 6

BulkJob

  • POSTcreateBulkUploadJob/v1/accounts/:accountId/upload/jobs
  • GETgetBulkJobStatus/v1/accounts/:accountId/upload/jobs/:jobId
  • POSTuploadCompleteBulkJob/v1/accounts/:accountId/upload/jobs/:jobId/actions/complete

Agreements

  • GETGetAgreementsList/v1/accounts/:accountId/agreements?limit=10&ctoken=abc123&$filter=parties/name_in_agreement eq 'HEALTHEON CORPORATION'&sort=string&direction=asc&id=string&document_id=string&status=string&review_status=string&review_completed_at=string&parties.name_in_agreement=string&metadata.created_at=string&title=string&related_agreement_documents.parent_agreement_document_id=string&languages=string&provisions.effective_date=string&provisions.expiration_date=string&provisions.execution_date=string&provisions.term_length=string&source_name=string&source_id=string
  • GETGetAgreement/v1/accounts/:accountId/agreements/:agreementId
  • DELETEDeleteAgreement/v1/accounts/:accountId/agreements/:agreementId

API details

Base URL
https://api.docusign.com
https://api-d.docusign.com
https://api-s.docusign.com
https://api.dev.docusign.net
Authentication
OAuth 2.0 (authorization code flow) with 2 scopes
Operations
6 operations on 5 pathsGET 3POST 2DELETE 1
Main resources
Agreements 3BulkJob 3
Response formats
application/json application/problem+json text/plain
Description format
OpenAPI 3.1.0, API version 0.7.1-beta

How to test the Agreements API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Agreements API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “createBulkUploadJob” (POST /v1/accounts/:accountId/upload/jobs), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Agreements API?

API for retrieving agreements It is listed under Other and has 6 endpoints.

Who publishes the Agreements API?

It is listed from DocuSign's public API description (an OpenAPI document), not published by DocuSign on Swastik Codes. Anyone who controls docusign.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Agreements API?

Its description lists 4 base URLs: https://api.docusign.com, https://api-d.docusign.com, https://api-s.docusign.com, https://api.dev.docusign.net. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Agreements API?

With OAuth 2.0 (authorization code flow) with 2 scopes.

How many endpoints does the Agreements API have?

6 operations on 5 paths (3 GET, 2 POST, 1 DELETE). The largest groups are Agreements, BulkJob.

Is forking the Agreements API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.