Dropbox Sign/bulkSendJobGet

Preview only · details below

Dropbox SignDropbox Sign eSignature API

GET/bulk_send_job/{bulk_send_job_id}

Get Bulk Send Job

Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter.

Manage accounts, signature requests, templates, teams, bulk sends, file downloads, fax, and event callbacks through the complete Dropbox Sign v3 API; the Hub provides documentation and a local SDK/CLI only.

Request

operationId
bulkSendJobGet
Server
https://api.hellosign.com/v3
Authentication
api_key, oauth2

Request parameters

bulk_send_job_id

pathstringrequired

The id of the BulkSendJob to retrieve.

6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174

page

queryinteger

Which page number of the BulkSendJob list to return. Defaults to `1`.

1

page_size

queryinteger

Number of objects to be returned per page. Must be between `1` and `100`. Default is 20.

20

Responses

200

BulkSendJobGetResponseapplication/json

successful operation

Properties: bulk_send_joblist_infosignature_requestswarnings

4XX

ErrorResponseapplication/json

failed_operation

Properties: error

{
  "bulk_send_job": {
    "bulk_send_job_id": "example-bulk-send-job-id",
    "total": 0,
    "is_creator": false,
    "created_at": 0
  },
  "list_info": {
    "num_pages": 0,
    "num_results": 0,
    "page": 0,
    "page_size": 0
  },
  "signature_requests": [
    {}
  ],
  "warnings": [
    {
      "warning_name": "Example Name"
    }
  ]
}