Bulk Send Job

Get Bulk Send Job

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

get/bulk_send_job/{bulk_send_job_id}

Path parameters

bulk_send_job_idstring required

The id of the BulkSendJob to retrieve.

Query parameters

pageinteger

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

page_sizeinteger

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

Response

successful operation

Changes

Changed in 8 of the 53 revisions of this API.14210

    • removed the optional property signature_requests/items/allOf[SignatureRequestResponse]/signer_experience from the response with the 200 status

      response-optional-property-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the signature_requests/items/allOf[SignatureRequestResponse]/signer_experience response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • removed the required property signature_requests/items/allOf[SignatureRequestResponse]/signer_experience/form_view from the response with the 200 status

      response-required-property-removed

    • added SignatureRequestSignerExperience to the signature_requests/items/allOf[SignatureRequestResponse]/signer_experience response property allOf list for the response status 200

      response-property-all-of-added

    • added the optional property signature_requests/items/allOf[SignatureRequestResponse]/signer_experience to the response with the 200 status

      response-optional-property-added

  • 00dd8535e60b31See the full diff
    • the response property signature_requests/items/allOf[SignatureRequestResponse]/custom_fields/items/editor became nullable for the status 200

      response-property-became-nullable

    • the response property signature_requests/items/allOf[SignatureRequestResponse]/expires_at became nullable for the status 200

      response-property-became-nullable

    • the response property signature_requests/items/allOf[SignatureRequestResponse]/requester_email_address became nullable for the status 200

      response-property-became-nullable

    • added the optional property signature_requests/items/allOf[subschema #2]/metadata to the response with the 200 status

      response-optional-property-added

    • the response property bulk_send_job/bulk_send_job_id became nullable for the status 200

      response-property-became-nullable

    • the response property bulk_send_job/bulk_send_job_id became optional for the status 200

      response-property-became-optional

    • the response property bulk_send_job/created_at became optional for the status 200

      response-property-became-optional

    • the response property bulk_send_job/is_creator became optional for the status 200

      response-property-became-optional

    • the response property bulk_send_job/total became optional for the status 200

      response-property-became-optional

    • the response property bulk_send_job/bulk_send_job_id became required for the status 200

      response-property-became-required

    • the response property bulk_send_job/created_at became required for the status 200

      response-property-became-required

    • the response property bulk_send_job/is_creator became required for the status 200

      response-property-became-required

    • the response property bulk_send_job/total became required for the status 200

      response-property-became-required

    • the response property bulk_send_job became required for the status 200

      response-property-became-required

    • the response property list_info became required for the status 200

      response-property-became-required

    • the response property signature_requests became required for the status 200

      response-property-became-required

  • e9603b26e6f841See the full diff
    • the response property signature_requests/items/allOf[SignatureRequestResponse]/test_mode became nullable for the status 200

      response-property-became-nullable

    • the response property bulk_send_job became optional for the status 200

      response-property-became-optional

    • the response property list_info became optional for the status 200

      response-property-became-optional

    • the response property signature_requests became optional for the status 200

      response-property-became-optional

    • removed the optional property signature_requests/items/allOf[subschema #2]/metadata from the response with the 200 status

      response-optional-property-removed

    This revision also has 49 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog