TextMineHome
API Reference

Search documents with query parameters

get
https://api.textmine.com/v3/documents/search

Searches documents by text query, team IDs, Vault IDs, document type IDs, status, and publication date range.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Full-text query.

team_ids
array of int64s

Team IDs.

team_ids
vault_ids
array of int64s

Vault IDs.

vault_ids
document_type_ids
array of int64s

Document type IDs.

document_type_ids
string

Document status.

date-time

Inclusive start of publication date range.

date-time

Inclusive end of publication date range.

string

Opaque cursor from the previous page. V3 currently uses numeric offsets as cursors.

integer
1 to 200
Defaults to 50

Maximum number of items to return. Values above the service limit are clamped.

Responses

Updated 7 days ago

Language
Credentials
Bearer
tm_<key>
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 days ago