Raw schema
{
"type": "object",
"properties": {
"term": {
"description": "General full-text 'other terms' query (maps to query.term).",
"type": "string"
},
"condition": {
"description": "Disease / condition to match (maps to query.cond), e.g. 'diabetes'.",
"type": "string"
},
"intervention": {
"description": "Treatment / drug / intervention to match (maps to query.intr).",
"type": "string"
},
"title": {
"description": "Words in the study title (maps to query.titles).",
"type": "string"
},
"location": {
"description": "Study location text, e.g. a city/state/country (maps to query.locn).",
"type": "string"
},
"sponsor": {
"description": "Sponsor / collaborator name (maps to query.spons).",
"type": "string"
},
"ids": {
"description": "Restrict to these NCT ids (maps to filter.ids), e.g. ['NCT00841061'].",
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"description": "Filter by overall recruitment status (maps to filter.overallStatus). One or more of: ACTIVE_NOT_RECRUITING, COMPLETED, ENROLLING_BY_INVITATION, NOT_YET_RECRUITING, RECRUITING, SUSPENDED, TERMINATED, WITHDRAWN, AVAILABLE, NO_LONGER_AVAILABLE, TEMPORARILY_NOT_AVAILABLE, APPROVED_FOR_MARKETING, WITHHELD, UNKNOWN.",
"type": "array",
"items": {
"type": "string",
"enum": [
"ACTIVE_NOT_RECRUITING",
"COMPLETED",
"ENROLLING_BY_INVITATION",
"NOT_YET_RECRUITING",
"RECRUITING",
"SUSPENDED",
"TERMINATED",
"WITHDRAWN",
"AVAILABLE",
"NO_LONGER_AVAILABLE",
"TEMPORARILY_NOT_AVAILABLE",
"APPROVED_FOR_MARKETING",
"WITHHELD",
"UNKNOWN"
]
}
},
"geoFilter": {
"description": "Geo filter as a raw geo-function string (maps to filter.geo), e.g. 'distance(39.0027,-77.1,50mi)'.",
"type": "string"
},
"advanced": {
"description": "Advanced Essie expression applied as an additional filter (maps to filter.advanced).",
"type": "string"
},
"fields": {
"description": "Fields or modules to return, e.g. ['NCTId','BriefTitle','OverallStatus'] or ['protocolSection.identificationModule']. Omit to return full study records.",
"type": "array",
"items": {
"type": "string"
}
},
"sort": {
"description": "Sort order, e.g. '@relevance', 'LastUpdatePostDate:desc', 'EnrollmentCount:desc', 'StudyFirstPostDate:desc'.",
"type": "string"
},
"pageSize": {
"description": "Number of studies per page (1โ1000; API default 10).",
"type": "integer",
"minimum": 1,
"maximum": 1000
},
"pageToken": {
"description": "Opaque token from a previous response's nextPageToken, to fetch the next page.",
"type": "string"
},
"countTotal": {
"description": "Include the total number of matching studies (totalCount) on the first page.",
"type": "boolean"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}