Skip to Content

POST /cohort/search

Search Cohort

Search cohorts — composable infra architecture.

Request Body (SearchCohortApiRequest)

FieldTypeRequiredDescription
searchstringNo
filter_profile_idsstring[]No
filter_simulation_idsstring[]No
filter_department_idsstring[]No
profile_searchstringNo
simulation_searchstringNo
department_searchstringNo
flag_searchstringNo
page_sizeintegerNo
page_offsetintegerNo
snapshot_keystringNoCache snapshot key for consistent reads across related requests

Response (ListCohortApiResponse)

FieldTypeRequiredDescription
actor_namestringNoDisplay name of the current user
user_rolestringNoRole of the current user
cohortsListCohortApiCohort[]NoList of cohorts
profilesListCohortApiProfile[]NoList of profiles for filtering
simulationsListCohortApiSimulation[]NoList of simulations for filtering
departmentsListCohortApiDepartment[]NoList of departments for filtering
simulation_filterListFilterSectionNoFilter options for simulations in list UI
profile_filterListFilterSectionNoFilter options for profiles in list UI
department_filterListFilterSectionNoFilter options for departments in list UI
flag_filterListFilterSectionNoFilter options for flags in list UI
total_countintegerNoTotal number of matching records
import_fieldsImportField[]NoCSV import column schema for the bulk-import dialog
Last updated on