The DiscoverText API is a fully RESTful API, and all calls to the API are GET requests and return JSON responses, except as noted on the documentation for specific calls.
Authorization and Headers
All API calls need to include an authorization header with a valid JWT bearer token (gotten from login API call), except for the initial call to login to obtain the token. In addition, all calls should include the Content-Type header set to "application/json".
Content-Type: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Item List Pagnation
When querying a collection type, you can specify the offset and limit the number of results to retrieve. See the Collection documentation for additional details.
Request Item Filtering and Sorting
On most, but not all, GET API calls that return a Collection allow for filtering and sorting of the result items. Note that not all calls support this, and not all fields are filterable or sortable.
To filter results, add the field name and filter value as a key/value pair to the query parameters. For example to filter on the field name for projects that contain example:
https://api.discovertext.com/api/v1/projects?name=example
To sort results, add the sort parameter and the field and direction to sort as the value. For example, to sort by project name in descending order:
https://api.discovertext.com/api/v1/projects?sort=name:desc