API ReferenceChangelogDiscussions
Log In
API Reference

Get studies definitions with criterias

Returns the list of studies.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
agenciesIds
array of strings

Use this field to filter result on agencies. Only studies belonging to the specified agencies will be returned.

agenciesIds
boolean

If true, only enabled studies will be returned.

studyIds
array of strings

List of study identifiers. If provided, all other filtering parameters are ignored.

studyIds
date-time

Use this field to filter result on validity date. Only studies still valid at this date will be returned, i.e. studies whose validity end date is greater or equal. Studies with no validity end date are excluded.

date-time

Use this field to filter result on validity date. Only studies already valid at this date will be returned, i.e. studies whose validity start date is lesser or equal. Studies with no validity start date are excluded. Combined with validFrom, the returned studies are the ones valid at some point between the two dates.

Headers
boolean
Defaults to false
Response

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