Query: Find Navigator Agreement

Docusign Operation

The Find Navigator Agreement query searches for and retrieves a specific agreement or template within DocuSign Navigator.

Example User Story

I want to find our standard service agreement in DocuSign Navigator, so I can quickly send it to new clients for e-signature.

Fields

Field Name	Field Type	Required
agreementId	String	Yes

Related Connections

Docusign

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "find-navigator-agreement",
  "state": "inDev",
  "meta": {
    "short": "Find Navigator Agreement",
    "description": "Retrieves a specific navigator agreement from DocuSign based on the provided agreement ID."
  },
  "input": [
    {
      "name": "agreementId",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The unique identifier of the navigator agreement to retrieve."
      }
    }
  ],
  "output": [
    {
      "name": "agreement",
      "type": "Object",
      "selector": ["agreement"],
      "meta": {
        "description": "The retrieved navigator agreement object."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "GET",
        "path": "/v2.1/accounts/{{accountId}}/envelopes/{{agreementId}}",
        "headers": {
          "Accept": "application/json"
        }
      }
    }
  ]
}