Search for documents, templates, and document groups
This endpoint allows API users to search across their documents, templates, document groups, and document group templates. Search covers all folders accessible to the user, including own, shared, and team folders. Results are sorted by the date updated, from newest to oldest.
Each search_by value uses its own matching logic and minimum search_key length:
| search_by value | Searches | Matching | Min search_key length |
|---|---|---|---|
| name | Entity name | Contains | 1 |
| id | Entity ID | Exact match | — |
| inviter-email | Inviter email | Prefix | 2 |
| signer-email | Signer email | Prefix | 2 |
| document-text | Text inside the document | Substring | 3 |
Matching is case-insensitive. Leading and trailing whitespace in search_key is trimmed before the length check. If search_key is shorter than the minimum for a given field, that field returns no results without a validation error. For inviter-email and signer-email, the prefix match applies to the first 40 characters of the email; a longer search_key matches by exact email value.
The maximum number of results before pagination is 1,000.
Request
- Base URLhttps://api.signnow.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Search phrase. Must be a non-empty string.
Comma-separated list of fields to search by. Possible values: name, id, inviter-email, signer-email, document-text.
Number of results per page. Possible values: 1–20.
Page number. Must be greater than 0.
Response
Success. entity_properties content depends on entity_type. An empty result returns HTTP 200 with an empty data array and meta.pagination.total set to 0. Document text and emails are used for matching only and are not returned in the response.
Changes
No recorded changes to this operation across all 1 revision of this API.