Dropbox Embedded API

_md__OpenApi::TAG::EMBEDDED::DESCRIPTION

Operations 2

POST /embedded/edit_url/{template_id} Dropbox _t__EmbeddedEditUrl::SUMMARY #
GET /embedded/sign_url/{signature_id} Dropbox _t__EmbeddedSignUrl::SUMMARY #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/dropbox-embedded-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

dropbox-embedded-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Dropbox Sign Embedded API
  description: The Dropbox Sign API offers a reliable, flexible set of eSignature tools that can be used to power digital agreements and turn slow, outdated business processes into a competitive advantage. With a broad range of highly-configurable features, the Dropbox Sign API empowers you to build secure signing experiences and document workflows that delight your users.
  termsOfService: https://www.hellosign.com/terms
  contact:
    email: apisupport@hellosign.com
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 3.0.0
servers:
- url: https://api.hellosign.com/v3
security:
- api_key: []
  oauth2:
  - account_access
  - signature_request_access
  - template_access
  - team_access
  - api_app_access
  - basic_account_info
  - request_signature
tags:
- name: Embedded
  description: _md__OpenApi::TAG::EMBEDDED::DESCRIPTION
paths:
  /embedded/edit_url/{template_id}:
    post:
      tags:
      - Embedded
      summary: Dropbox _t__EmbeddedEditUrl::SUMMARY
      description: _t__EmbeddedEditUrl::DESCRIPTION
      operationId: embeddedEditUrl
      parameters:
      - name: template_id
        in: path
        description: _t__EmbeddedEditUrl::TEMPLATE_ID
        required: true
        schema:
          type: string
        example: f57db65d3f933b5316d398057a36176831451a35
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmbeddedEditUrlRequest'
            examples:
              default_example:
                $ref: '#/components/examples/EmbeddedEditUrlRequestDefaultExample'
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedEditUrlResponse'
              examples:
                default_example:
                  $ref: '#/components/examples/EmbeddedEditUrlResponseExample'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400ResponseExample'
                401_example:
                  $ref: '#/components/examples/Error401ResponseExample'
                402_example:
                  $ref: '#/components/examples/Error402ResponseExample'
                403_example:
                  $ref: '#/components/examples/Error403ResponseExample'
                404_example:
                  $ref: '#/components/examples/Error404ResponseExample'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponseExample'
      security:
      - api_key: []
      - oauth2:
        - template_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/EmbeddedEditUrl.php
      - lang: C#
        label: C#
        source:
          $ref: examples/EmbeddedEditUrl.cs
      - lang: JavaScript
        label: JavaScript
        source:
          $ref: examples/EmbeddedEditUrl.js
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/EmbeddedEditUrl.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/EmbeddedEditUrl.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/EmbeddedEditUrl.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/EmbeddedEditUrl.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/EmbeddedEditUrl.sh
      x-meta:
        seo:
          title: _t__EmbeddedEditUrl::SEO::TITLE
          description: _t__EmbeddedEditUrl::SEO::DESCRIPTION
  /embedded/sign_url/{signature_id}:
    get:
      tags:
      - Embedded
      summary: Dropbox _t__EmbeddedSignUrl::SUMMARY
      description: _t__EmbeddedSignUrl::DESCRIPTION
      operationId: embeddedSignUrl
      parameters:
      - name: signature_id
        in: path
        description: _t__EmbeddedSignUrl::SIGNATURE_ID
        required: true
        schema:
          type: string
        example: 50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedSignUrlResponse'
              examples:
                default_example:
                  $ref: '#/components/examples/EmbeddedSignUrlResponseExample'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400ResponseExample'
                401_example:
                  $ref: '#/components/examples/Error401ResponseExample'
                402_example:
                  $ref: '#/components/examples/Error402ResponseExample'
                403_example:
                  $ref: '#/components/examples/Error403ResponseExample'
                404_example:
                  $ref: '#/components/examples/Error404ResponseExample'
                409_example:
                  $ref: '#/components/examples/Error409ResponseExample'
                429_example:
                  $ref: '#/components/examples/Error429ResponseExample'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponseExample'
      security:
      - api_key: []
      - oauth2:
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/EmbeddedSignUrl.php
      - lang: C#
        label: C#
        source:
          $ref: examples/EmbeddedSignUrl.cs
      - lang: JavaScript
        label: JavaScript
        source:
          $ref: examples/EmbeddedSignUrl.js
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/EmbeddedSignUrl.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/EmbeddedSignUrl.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/EmbeddedSignUrl.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/EmbeddedSignUrl.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/EmbeddedSignUrl.sh
      x-meta:
        seo:
          title: _t__EmbeddedSignUrl::SEO::TITLE
          description: _t__EmbeddedSignUrl::SEO::DESCRIPTION
components:
  schemas:
    EmbeddedSignUrlResponseEmbedded:
      description: _t__EmbeddedSignUrlResponseEmbedded::DESCRIPTION
      properties:
        sign_url:
          description: _t__EmbeddedSignUrlResponseEmbedded::SIGN_URL
          type: string
        expires_at:
          description: _t__EmbeddedSignUrlResponseEmbedded::EXPIRES_AT
          type: integer
      type: object
      x-internal: true
    EmbeddedEditUrlRequest:
      properties:
        allow_edit_ccs:
          description: _t__EmbeddedEditUrl::ALLOW_EDIT_CCS
          type: boolean
          default: false
        cc_roles:
          description: _t__EmbeddedEditUrl::CC_ROLES
          type: array
          items:
            type: string
        editor_options:
          $ref: '#/components/schemas/SubEditorOptions'
        force_signer_roles:
          description: _t__EmbeddedEditUrl::FORCE_SIGNER_ROLES
          type: boolean
          default: false
        force_subject_message:
          description: _t__EmbeddedEditUrl::FORCE_SUBJECT_MESSAGE
          type: boolean
          default: false
        merge_fields:
          description: _t__EmbeddedEditUrl::MERGE_FIELDS
          type: array
          items:
            $ref: '#/components/schemas/SubMergeField'
        preview_only:
          description: _t__EmbeddedEditUrl::PREVIEW_ONLY
          type: boolean
          default: false
        show_preview:
          description: _t__EmbeddedEditUrl::SHOW_PREVIEW
          type: boolean
          default: false
        show_progress_stepper:
          description: _t__EmbeddedEditUrl::SHOW_PROGRESS_STEPPER
          type: boolean
          default: true
        test_mode:
          description: _t__EmbeddedEditUrl::TEST_MODE
          type: boolean
          default: false
      type: object
    ErrorResponse:
      required:
      - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorResponseError'
      type: object
    SubMergeField:
      required:
      - name
      - type
      properties:
        name:
          description: _t__Sub::MergeField::NAME
          type: string
        type:
          description: _t__Sub::MergeField::TYPE
          type: string
          enum:
          - text
          - checkbox
          x-enumDescriptions:
            text: _t__Sub::MergeField::EnumDescriptions::TEXT
            checkbox: _t__Sub::MergeField::EnumDescriptions::CHECKBOX
      type: object
    ErrorResponseError:
      description: _t__ErrorResponseError::DESCRIPTION
      required:
      - error_msg
      - error_name
      properties:
        error_msg:
          description: _t__ErrorResponseError::ERROR_MSG
          type: string
        error_path:
          description: _t__ErrorResponseError::ERROR_PATH
          type: string
        error_name:
          description: _t__ErrorResponseError::ERROR_NAME
          type: string
      type: object
    WarningResponse:
      description: _t__WarningResponse::LIST_DESCRIPTION
      required:
      - warning_msg
      - warning_name
      properties:
        warning_msg:
          description: _t__WarningResponse::WARNING_MSG
          type: string
        warning_name:
          description: _t__WarningResponse::WARNING_NAME
          type: string
      type: object
    SubEditorOptions:
      description: _t__Sub::EditorOptions::DESCRIPTION
      properties:
        allow_edit_signers:
          description: _t__Sub::EditorOptions::ALLOW_EDIT_SIGNERS
          type: boolean
          default: false
        allow_edit_documents:
          description: _t__Sub::EditorOptions::ALLOW_EDIT_DOCUMENTS
          type: boolean
          default: false
      type: object
    EmbeddedSignUrlResponse:
      properties:
        embedded:
          $ref: '#/components/schemas/EmbeddedSignUrlResponseEmbedded'
        warnings:
          description: _t__WarningResponse::LIST_DESCRIPTION
          type: array
          items:
            $ref: '#/components/schemas/WarningResponse'
      type: object
      x-internal: true
    EmbeddedEditUrlResponse:
      properties:
        embedded:
          $ref: '#/components/schemas/EmbeddedEditUrlResponseEmbedded'
        warnings:
          description: _t__WarningResponse::LIST_DESCRIPTION
          type: array
          items:
            $ref: '#/components/schemas/WarningResponse'
      type: object
      x-internal: true
    EmbeddedEditUrlResponseEmbedded:
      description: _t__EmbeddedEditUrlResponseEmbedded::DESCRIPTION
      properties:
        edit_url:
          description: _t__EmbeddedEditUrlResponseEmbedded::EDIT_URL
          type: string
        expires_at:
          description: _t__EmbeddedEditUrlResponseEmbedded::EXPIRES_AT
          type: integer
      type: object
      x-internal: true
  examples:
    Error402ResponseExample:
      summary: _t__Error::402
      value:
        $ref: examples/json/Error402ResponseExample.json
    EmbeddedEditUrlResponseExample:
      summary: _t__EmbeddedEditUrlResponseExample::SUMMARY
      value:
        $ref: examples/json/EmbeddedEditUrlResponseExample.json
    Error403ResponseExample:
      summary: _t__Error::403
      value:
        $ref: examples/json/Error403ResponseExample.json
    Error4XXResponseExample:
      summary: _t__Error::4XX
      value:
        $ref: examples/json/Error4XXResponseExample.json
    Error401ResponseExample:
      summary: _t__Error::401
      value:
        $ref: examples/json/Error401ResponseExample.json
    EmbeddedSignUrlResponseExample:
      summary: _t__EmbeddedSignUrlResponseExample::SUMMARY
      value:
        $ref: examples/json/EmbeddedSignUrlResponseExample.json
    EmbeddedEditUrlRequestDefaultExample:
      summary: Default Example
      value:
        $ref: examples/json/EmbeddedEditUrlRequestDefaultExample.json
    Error400ResponseExample:
      summary: _t__Error::400
      value:
        $ref: examples/json/Error400ResponseExample.json
    Error409ResponseExample:
      summary: _t__Error::409
      value:
        $ref: examples/json/Error409ResponseExample.json
    Error429ResponseExample:
      summary: _t__Error::429
      value:
        $ref: examples/json/Error429ResponseExample.json
    Error404ResponseExample:
      summary: _t__Error::404
      value:
        $ref: examples/json/Error404ResponseExample.json
  headers:
    X-RateLimit-Limit:
      description: _t__Common::RateLimiting::LIMIT
      schema:
        type: integer
        format: int32
        example: 100
    X-Ratelimit-Reset:
      description: _t__Common::RateLimiting::RESET
      schema:
        type: integer
        format: int64
        example: 1430170900
    X-RateLimit-Remaining:
      description: _t__Common::RateLimiting::REMAINING
      schema:
        type: integer
        format: int32
        example: 99
  securitySchemes:
    api_key:
      type: http
      description: _t__OpenApi::AUTH::API_KEY
      scheme: basic
    oauth2:
      type: http
      description: _t__OpenApi::AUTH::OAUTH
      bearerFormat: JWT
      scheme: bearer
externalDocs:
  description: Legacy API Reference
  url: https://app.hellosign.com/api/reference