Chilkat Online Tools

C / DocuSign REST API / Gets a list of envelope documents.

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject queryParams;
    HCkHttpResponse resp;

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    http = CkHttp_Create();

    queryParams = CkJsonObject_Create();
    CkJsonObject_UpdateString(queryParams,"documents_by_userid","{{documents_by_userid}}");
    CkJsonObject_UpdateString(queryParams,"include_document_size","{{include_document_size}}");
    CkJsonObject_UpdateString(queryParams,"include_metadata","{{include_metadata}}");
    CkJsonObject_UpdateString(queryParams,"include_tabs","{{include_tabs}}");
    CkJsonObject_UpdateString(queryParams,"recipient_id","{{recipient_id}}");
    CkJsonObject_UpdateString(queryParams,"shared_user_id","{{shared_user_id}}");

    // Adds the "Authorization: Bearer {{accessToken}}" header.
    CkHttp_putAuthToken(http,"{{accessToken}}");
    CkHttp_SetRequestHeader(http,"Accept","application/json");

    resp = CkHttp_QuickRequestParams(http,"GET","https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents",queryParams);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(queryParams);
        return;
    }

    printf("%d\n",CkHttpResponse_getStatusCode(resp));
    printf("%s\n",CkHttpResponse_bodyStr(resp));
    CkHttpResponse_Dispose(resp);


    CkHttp_Dispose(http);
    CkJsonObject_Dispose(queryParams);

    }

Curl Command

curl -G -d "documents_by_userid=%7B%7Bdocuments_by_userid%7D%7D"
	-d "include_document_size=%7B%7Binclude_document_size%7D%7D"
	-d "include_metadata=%7B%7Binclude_metadata%7D%7D"
	-d "include_tabs=%7B%7Binclude_tabs%7D%7D"
	-d "recipient_id=%7B%7Brecipient_id%7D%7D"
	-d "shared_user_id=%7B%7Bshared_user_id%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents

Postman Collection Item JSON

{
  "name": "Gets a list of envelope documents.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents?documents_by_userid={{documents_by_userid}}&include_document_size={{include_document_size}}&include_metadata={{include_metadata}}&include_tabs={{include_tabs}}&recipient_id={{recipient_id}}&shared_user_id={{shared_user_id}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "documents"
      ],
      "query": [
        {
          "key": "documents_by_userid",
          "value": "{{documents_by_userid}}"
        },
        {
          "key": "include_document_size",
          "value": "{{include_document_size}}"
        },
        {
          "key": "include_metadata",
          "value": "{{include_metadata}}"
        },
        {
          "key": "include_tabs",
          "value": "{{include_tabs}}"
        },
        {
          "key": "recipient_id",
          "value": "{{recipient_id}}"
        },
        {
          "key": "shared_user_id",
          "value": "{{shared_user_id}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}"
        }
      ]
    },
    "description": "Retrieves a list of documents associated with the specified envelope."
  },
  "response": [
  ]
}