Get user's documents
This endpoint allows API users to search the documents of an organization's users. Available only to the Administrator of the organization.
The filters query parameter is required. It is an array of filters and must contain at least one filter, for example ?filters=[{"name":{"type":"=","value":"sample name"}}]. A request without filters returns an error.
Pay attention: emails must be encoded in such format sample_name%40email.com
Request
- Base URLhttps://api.signnow.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
ID of organization
Query parameters
Searches documents by document name. The type must be =. Example: ?filters=[{"name":{"type":"=","value":"sample name"}}] At least one filter is required.
Searches documents by signer email. Example: ?filters=[{"signer":{"type":"=","value":"signer%40email.com"}}] At least one filter is required.
Searches documents by owner email. Example: ?filters=[{"owner":{"type":"=","value":"owner%40email.com"}}] At least one filter is required.
Searches documents by the text in their text fields. Example: ?filters=[{"text":{"type":"=","value":"Some sample text"}}] At least one filter is required.
Searches documents by document status. Possible values: waiting_for_signing, signed, pending_payment. Example: ?filters=[{"status":{"type":"=","value":"signed"}}] At least one filter is required.
Page number of the search results. Min: 1. Example: ?page=3
Sorts documents by document name. Possible values: asc, desc. Example: ?sort[name]=asc
Sorts documents by the date they were added. Possible values: asc, desc. Example: ?sort[added]=asc
Sorts documents by the date they were last changed. Possible values: asc, desc. Example: ?sort[changed]=asc
Number of search results per page. Min: 1. Example: ?per_page=12
Headers
application/json
Response
Search by Signer email
Changes
No recorded changes to this operation across all 1 revision of this API.