Skip to main content

Get signing documents

List (unarchived) signing documents. Use /status/ if you need high-level information.

Query Parameters
  • archived string

    Filter on archived status, default is false

  • email string

    Filter by signer email

  • limit integer

    Length of dataset to return. Use with offset query to iterate through results.

  • offset integer

    Offset from start of dataset. Use with the limit query to iterate through dataset.

  • group string

    Filter by a specific group

  • status integer

    Filter on document status

  • nosigners string

    Add value '1' to remove signers information for a faster query

Responses

successful operation, list of document objects

Schema
  • meta object
    • limit int32
    • next string
    • offset int32
    • previous string
    • total_count int32

      total number of objects

  • objects object[]
    • archived boolean
    • auto_archive boolean
    • cc_emails string
    • created date-time
    • do_email boolean
    • download_final boolean
    • group string

      Possible values: Value must match regular expression ^/api/v1/group/[-\w]{1,50}/$

    • modified date-time
    • name string
    • pdftext string
    • redirect string
    • resource_uri string
    • return_signer_links boolean
    • signers array[]

      nested arrays with signer details

    • signers_in_order boolean
    • status integer

      Possible values: [4, 5, 10, 15, 20, 30, 35, 39, 40, 50, 60]

      Signer status options:

      • 4 - unsent
      • 5 - scheduled to be sent
      • 10 - sent
      • 15 - email opened
      • 20 - visited
      • 30 - fields complete
      • 35 - fields complete ex signature
      • 39 - waiting for witness to complete
      • 40 - signed
      • 50 - downloaded
      • 60 - rejected
    • tag string

      Possible values: Value must match regular expression ^[-\w\[\]\:\;\/\.\, _]{0,250}$

    • template string

      Possible values: Value must match regular expression ^/api/v1/template/[-\w]{1,60}/$

    • templatepdf string

      Possible values: Value must match regular expression ^/api/v1/templatepdf/[-\w]{1,60}/$

    • text string
    • user string

      Possible values: Value must match regular expression ^/api/v1/user/[-\w]{1,60}/$

    • uuid uuid