Docusign Navigator Rest Swagger
DocuSign Navigator REST Swagger is an API connector for DocuSign Navigator, a tool for organizing, finding, and working with agreement information.
- Base URL:
https://api.docusign.com - Auth: OAuth 2.0 (user-delegated) — attach an InTouch
oauthcredential. Mint one withitcli.py /oauth <provider>(device-code) or/google-auth(Google); the server auto-refreshes the access token before each run, so the connector never handles or stores tokens.
Operations
getagreementslist— GET /v1/accounts/{accountId}/agreementsgetagreement— GET /v1/accounts/{accountId}/agreements/{agreementId}getbulkjobstatus— GET /v1/accounts/{accountId}/upload/jobs/{jobId}deleteagreement— DELETE /v1/accounts/{accountId}/agreements/{agreementId}createbulkuploadjob— POST /v1/accounts/{accountId}/upload/jobsuploadcompletebulkjob— POST /v1/accounts/{accountId}/upload/jobs/{jobId}/actions/complete
Inputs
- a linked
oauthcredential (no key inputs) — the server injects a freshAuthorization: Bearerfrom it operation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: getagreementslist
# (attach an 'oauth' credential to the task — no inline secrets)
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
operation |
string | yes | — | One of: getagreementslist, getagreement, getbulkjobstatus, deleteagreement, createbulkuploadjob, uploadcompletebulkjob |
accountId |
string | no | — | Path parameter accountId (required by some operations). |
agreementId |
string | no | — | Path parameter agreementId (required by some operations). |
jobId |
string | no | — | Path parameter jobId (required by some operations). |
query |
string | no | — | Optional query params as a JSON object string, e.g. {"limit": 10}. |
body |
string | no | — | Request body as a JSON object string (for create/update operations). |