Skip to Content

POST /profile/search

Search Profile

Search profiles — composable infra architecture.

Request Body (SearchProfileApiRequest)

FieldTypeRequiredDescription
searchstringNo
cohort_idsstring[]No
filter_department_idsstring[]No
role_filterstringNo
cohort_searchstringNo
department_searchstringNo
role_searchstringNo
page_sizeintegerNo
page_offsetintegerNo
snapshot_keystringNoCache snapshot key for consistent reads across related requests

Response (ListProfilesApiResponse)

FieldTypeRequiredDescription
actor_namestringNoDisplay name of the acting user
profilesListProfilesApiProfile[]NoList of profile items
department_filterListFilterSectionNoFilter options for departments
role_filterListFilterSectionNoFilter options for roles
flag_filterListFilterSectionNoFilter options for flags in list UI
permissions_filterListFilterSectionNoFilter options for permissions in list UI
total_countintegerNoTotal number of profiles
Last updated on