Search documents

GET {{baseUrl}}/documents-search/?page=19875956&limit=19875956&q=velit et&name=velit et&signer_emails=velit et&status=velit et&who=velit et&format=velit et&signer_data=-1040341.9640929699

A search interface for fast, indexed searching of documents. This can be useful to have your users search for a document in your interface. Note that this indexed search includes documents for which a signature request flow has been initiated (i.e a signature request has been sent) and documents which are in draft state. If you would like to retrieve information on documents which have only been uploaded, you can do this via the /documents endpoint.

Normal search:

• ?q={{query}}

Using this query parameter, you can find documents by their UUID / ID, name, or by the emails of people involved in the signature request. Document names are tokenized on whitespace, hyphens and underscores to also match partial document names.

Search in document name:

• ?name={{query}}

Note: Searching by name returns exact results. For partial results, use the q parameter.

Available (extra) filters:

• ?signer_emails={{ signer@email.com }} (will filter documents that an email needed to sign/approve)
• ?status={{ si }}
• ?who={{ mo }}

To include multiple values for a filter field separate the values with a pipe (|). For example, to only search for sent documents and documents which have been viewed by a signer, use status=se|vi (sent and viewed).

Note: Only valid query parameters from the list below will return meaningful results. By default, if any malformed query parameter is provided, no filtering will occur and all documents will be returned (equivalent to a GET /documents)

Pagination:

• ?page={{ page_number: default 1 }}
• ?limit={{ limit results: default 10, max 100 }}

Format:

By default JSON is returned, to export data as csv or xls use the format parameter. Note that when using csv and xls, the data is returned as attachments in the response with the appropriate Content-Type header. You will need to ensure you are saving these responses as files, since they will not be in JSON format. It should also be noted that using page parameter in combination with format will return a 404 response as it's an invalid request. To export a subset of data, format can be combined with filter field values.

• ?format=csv
• ?format=xls

For csv and xls the data can also be exported with each signer on a separate row. In this mode also the signer inputs that have an external_id specified on a tag will be exported. All externalid's found will be exported as columns. To use this mode add the **signerdata** parameter.

If an incorrect argument is provided to this parameter, a 400 response with empty headers is returned for csv and xls formats.

• ?format=csv&signer_data=1
• ?format=xls&signer_data=1

Note that all documents are only ordered by created (newest first) when q or name are not used, else they are ordered by the strength of the match.

Request Params

HEADERS