Skip to main content

Get signing documents​

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

Query Parameters
  • group string required

    Filter by a specific group, required.

  • archived string

    Filter on archived status, default is false

  • email string

    Filter by signer email

  • limit integer

    Default value: 20

    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.

  • status integer

    Filter on document status

  • nosigners string

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

  • created_gt date-time

    Filter for those documents created after a certain time

  • modified_gt date-time

    Filter for those documents modified after a certain time

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[]

    Possible values: >= 8, <= 8

    nested arrays with signer details

  • signers_in_order int32

    Possible values: non-empty, [0, 1]

  • status integer

    Possible values: [10, 20, 30, 40, 50]

    Document status options:

    • 10 - Initial state, check signer status for sent/unsent
    • 20 - Fields completed
    • 30 - Signed
    • 40 - Removed (before signing)
    • 50 - Rejected
  • tag string

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

  • tag1 string

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

  • tag2 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
Loading...