Dropbox

Dropbox Sign API

Dropbox Sign v3 API

Productivity & workspace#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Dropbox Sign v3 API

Endpoints 83

Account

  • POSTCreate Account/account/createCreates a new Dropbox Sign Account that is associated with the specified email_address.
  • GETGet Account/accountReturns the properties and settings of your Account.
  • PUTUpdate Account/accountUpdates the properties and settings of your Account. Currently only allows for updates to the Callback URL and locale.
  • GETGet account settings/account/settingsaccount_id is an optional query parameter and defaults to the authenticated account. A team admin can specify another account on a team they administer.
  • POSTModify account settings/account/settingsaccount_id is an optional query parameter and defaults to the authenticated account. A team admin can specify another account on a team they administer.
  • POSTVerify Account/account/verifyVerifies whether an Dropbox Sign Account exists for the given email address.

Signature Request

  • POSTEmbedded Bulk Send with Template/signature_request/bulk_create_embedded_with_templateCreates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the template_ids parameter to be…
  • POSTBulk Send with Template/signature_request/bulk_send_with_templateCreates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the template_ids parameter. NOTE:…
  • POSTCancel Incomplete Signature Request/signature_request/cancel/:signature_request_idCancels an incomplete signature request. This action is not reversible. The request will be canceled and signers will no longer be able to sign. If they try…
  • POSTCreate Embedded Signature Request/signature_request/create_embeddedCreates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page…
  • POSTCreate Embedded Signature Request with Template/signature_request/create_embedded_with_templateCreates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in…
  • PUTEdit Signature Request/signature_request/edit/:signature_request_idEdits and sends a SignatureRequest with the submitted documents. If form_fields_per_document is not specified, a signature page will be affixed where all…
  • PUTEdit Embedded Signature Request/signature_request/edit_embedded/:signature_request_idEdits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will…
  • PUTEdit Embedded Signature Request with Template/signature_request/edit_embedded_with_template/:signature_request_idEdits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in…
  • PUTEdit Signature Request With Template/signature_request/edit_with_template/:signature_request_idEdits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. NOTE: Edit and resend *will* deduct your signature…
  • GETDownload Files/signature_request/files/:signature_request_idObtain a copy of the current documents specified by the signature_request_id parameter. Returns a PDF or ZIP file. If the files are currently being prepared,…
  • GETDownload Files as Data Uri/signature_request/files_as_data_uri/:signature_request_idObtain a copy of the current documents specified by the signature_request_id parameter. Returns a JSON object with a data_uri representing the base64 encoded…
  • GETDownload Files as File Url/signature_request/files_as_file_url/:signature_request_idObtain a copy of the current documents specified by the signature_request_id parameter. Returns a JSON object with a url to the file (PDFs only). If the files…
  • GETGet Signature Request/signature_request/:signature_request_idReturns the status of the SignatureRequest specified by the signature_request_id parameter.
  • GETList Signature Requests/signature_request/listReturns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been…
  • POSTRelease On-Hold Signature Request/signature_request/release_hold/:signature_request_idReleases a held SignatureRequest that was claimed and prepared from an UnclaimedDraft. The owner of the Draft must indicate at Draft creation that the…
  • POSTSend Request Reminder/signature_request/remind/:signature_request_idSends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This…
  • POSTRemove Signature Request Access/signature_request/remove/:signature_request_idRemoves your access to a completed signature request. This action is not reversible. The signature request must be fully executed by all parties (signed or…
  • POSTSend Signature Request/signature_request/sendCreates and sends a new SignatureRequest with the submitted documents. If form_fields_per_document is not specified, a signature page will be affixed where…
  • POSTSend with Template/signature_request/send_with_templateCreates and sends a new SignatureRequest based off of the Template(s) specified with the template_ids parameter.
  • POSTUpdate Signature Request/signature_request/update/:signature_request_idUpdates the email address and/or the name for a given signer on a signature request. You can listen for the signature_request_email_bounce event on your app…

Template

  • POSTAdd User to Template/template/add_user/:template_idGives the specified Account access to the specified Template. The specified Account must be a part of your Team.
  • POSTCreate Template/template/createCreates a template that can be used in future signature requests. If client_id is provided, the template will be created as an embedded template. Embedded…
  • POSTCreate Embedded Template Draft/template/create_embedded_draftThe first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage.
  • POSTDelete Template/template/delete/:template_idCompletely deletes the template specified from the account.
  • GETGet Template Files/template/files/:template_idObtain a copy of the current documents specified by the template_id parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status…
  • GETGet Template Files as Data Uri/template/files_as_data_uri/:template_idObtain a copy of the current documents specified by the template_id parameter. Returns a JSON object with a data_uri representing the base64 encoded file…
  • GETGet Template Files as File Url/template/files_as_file_url/:template_idObtain a copy of the current documents specified by the template_id parameter. Returns a JSON object with a url to the file (PDFs only). If the files are…
  • GETGet Template/template/:template_idReturns the Template specified by the template_id parameter.
  • GETList Templates/template/listReturns a list of the Templates that are accessible by you. Take a look at our search guide to learn more about querying templates.
  • POSTRemove User from Template/template/remove_user/:template_idRemoves the specified Account's access to the specified Template.
  • POSTUpdate Template Files/template/update_files/:template_idOverlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the…

Bulk Send Job

  • GETGet Bulk Send Job/bulk_send_job/:bulk_send_job_idReturns the status of the BulkSendJob and its SignatureRequests specified by the bulk_send_job_id parameter.
  • GETList Bulk Send Jobs/bulk_send_job/listReturns a list of BulkSendJob that you can access.

Report

  • POSTCreate Report/report/createRequest the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a…

Team

  • PUTAdd User to Team/team/add_memberInvites a user (specified using the email_address parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be…
  • POSTCreate Team/team/createCreates a new Team and makes you a member. You must not currently belong to a Team to invoke.
  • DELETEDelete Team/team/destroyDeletes your Team. Can only be invoked when you have a Team with only one member (yourself).
  • GETGet Team/teamReturns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of "not_found" will be…
  • PUTUpdate Team/teamUpdates the name of your Team.
  • GETGet Team Info/team/infoProvides information about a team.
  • GETList Team Invites/team/invitesProvides a list of team invites (and their roles).
  • GETList Team Members/team/members/:team_idProvides a paginated list of members (and their roles) that belong to a given team.
  • POSTRemove User from Team/team/remove_memberRemoves the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to…
  • GETGet team settings/team/settingsteam_id is an optional query parameter and defaults to the authenticated account's team. An organization admin can specify a subteam.
  • POSTModify team settings/team/settingsteam_id is an optional query parameter and defaults to the authenticated account's team. An organization admin can specify a subteam.
  • GETList Sub Teams/team/sub_teams/:team_idProvides a paginated list of sub teams that belong to a given team.

Unclaimed Draft

  • POSTCreate Unclaimed Draft/unclaimed_draft/createCreates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the…
  • POSTCreate Embedded Unclaimed Draft/unclaimed_draft/create_embeddedCreates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown…
  • POSTCreate Embedded Unclaimed Draft with Template/unclaimed_draft/create_embedded_with_templateCreates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL…
  • POSTEdit and Resend Unclaimed Draft/unclaimed_draft/edit_and_resend/:signature_request_idCreates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter test_mode can be edited prior to…

Embedded

  • POSTGet Embedded Template Edit URL/embedded/edit_url/:template_idRetrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are…
  • GETGet Embedded Sign URL/embedded/sign_url/:signature_idRetrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will…

Api App

  • POSTCreate API App/api_appCreates a new API App.
  • GETGet API App/api_app/:client_idReturns an object with information about an API App.
  • PUTUpdate API App/api_app/:client_idUpdates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional…
  • DELETEDelete API App/api_app/:client_idDeletes an API App. Can only be invoked for apps you own.
  • GETList API Apps/api_app/listReturns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates.

API Keys

  • GETList API Keys/api_keyReturns the API keys on the specified account. The key secret is not included.
  • POSTCreate API Key/api_keyCreates a named API key on the specified account. The secret is returned only in this response.
  • GETGet API Key/api_key/:api_key_idReturns one API key on the specified account. The key secret is not included.
  • PUTUpdate API Key/api_key/:api_key_idUpdates an API key's name, or promotes it to the primary key. Provide at least one of name or is_primary. is_primary can only be set to true.
  • DELETEDelete API Key/api_key/:api_key_idDeletes an API key. The primary key cannot be deleted. Promote another key first.

OAuth

  • POSTOAuth Token Generatehttps://app.hellosign.com/oauth/tokenOnce you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call.
  • POSTOAuth Token Refreshhttps://app.hellosign.com/oauth/token?refreshAccess tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also…

Fax Line

  • PUTAdd Fax Line User/fax_line/add_userGrants a user access to the specified Fax Line.
  • GETGet Available Fax Line Area Codes/fax_line/area_codes?country=USReturns a list of available area codes for a given state/province and city
  • POSTPurchase Fax Line/fax_line/createPurchases a new Fax Line
  • GETGet Fax Line/fax_line?number=123-123-1234Returns the properties and settings of a Fax Line.
  • DELETEDelete Fax Line/fax_lineDeletes the specified Fax Line from the subscription.
  • GETList Fax Lines/fax_line/listReturns the properties and settings of multiple Fax Lines.
  • PUTRemove Fax Line Access/fax_line/remove_userRemoves a user's access to the specified Fax Line

Document

  • POSTDetect Document Fields/document/detect_fieldsDetects form fields in a PDF document using either PDF form annotations or Dropbox Sign text tags.

Fax

  • GETGet Fax/fax/:fax_idReturns information about a Fax
  • DELETEDelete Fax/fax/:fax_idDeletes the specified Fax from the system
  • GETDownload Fax Files/fax/files/:fax_idDownloads files associated with a Fax
  • GETLists Faxes/fax/listReturns properties of multiple Faxes
  • POSTSend Fax/fax/sendCreates and sends a new Fax with the submitted file(s)

API details

Base URL
https://api.hellosign.com/v3
Authentication
HTTP Basic authentication (username and password)
A bearer token in the Authorization header
Operations
83 operations on 72 pathsPOST 36GET 31PUT 11DELETE 5
Main resources
Signature Request 20Team 12Template 11Fax Line 7Account 6API Keys 5Api App 5Fax 5Unclaimed Draft 4Bulk Send Job 2
Response formats
application/json application/pdf application/zip
Description format
OpenAPI 3.0.3, API version 3.0.0

How to test the Dropbox Sign API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Dropbox Sign API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create Account” (POST /account/create), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Dropbox Sign API?

Dropbox Sign v3 API It is listed under Productivity & workspace and has 83 endpoints.

Who publishes the Dropbox Sign API?

It is listed from Dropbox's public API description (an OpenAPI document), not published by Dropbox on Swastik Codes. Anyone who controls dropbox.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Dropbox Sign API?

Requests go to https://api.hellosign.com/v3. Endpoint paths are added to this base URL.

How do I authenticate with the Dropbox Sign API?

It accepts 2 methods: HTTP Basic authentication (username and password); A bearer token in the Authorization header.

How many endpoints does the Dropbox Sign API have?

83 operations on 72 paths (36 POST, 31 GET, 11 PUT, 5 DELETE). The largest groups are Signature Request, Team, Template, Fax Line.

Is forking the Dropbox Sign API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.