Search within an organization
GET
/api/v1/search/org_slug/{org_slug}API token
search:reador user sessionPerforms a paginated search across courses, folders, and users within the given organization. Query length and page size are capped to prevent data dumping. Requires authentication.
Path parameters
org_slugstringrequiredQuery parameters
querystringrequiredSearch query
pageintegerPage number
limitintegerItems per page (max 50)
Returns
SearchResult — Search results grouped by resource type
coursesCourseRead[]requiredShow child attributes
namestringrequireddescriptionstring | nullaboutstring | nulllearningsstring | nulltagsstring | nullthumbnail_typeenum | nullimagevideoboththumbnail_imagestring | nullthumbnail_videostring | nullpublicbooleanrequiredpublishedbooleanopen_to_contributorsbooleanrequiredidintegerrequiredorg_idintegerauthorsAuthorWithRole[]requiredShow child attributes
userUserReadrequiredShow child attributes
usernamestringrequiredfirst_namestringrequiredlast_namestringrequiredemailstringrequiredavatar_imagestring | nullbiostring | nulldetailsDetails | nullprofileProfile | nullextra_metadataExtra Metadata | nullidintegerrequireduser_uuidstringrequiredemail_verifiedbooleanlast_login_atstring | nullsignup_methodstring | nullis_superadminbooleanauthorshipResourceAuthorshipEnumrequiredCREATORCONTRIBUTORMAINTAINERREPORTERauthorship_statusResourceAuthorshipStatusEnumrequiredACTIVEPENDINGINACTIVEcreation_datestringrequiredupdate_datestringrequiredcourse_uuidstringrequiredcreation_datestringrequiredupdate_datestringrequiredseoSeo | nullextra_metadataExtra Metadata | nullfoldersFolderRead[]requiredShow child attributes
namestringrequiredpublicbooleandescriptionstring | nullthumbnail_imagestring | nullcolorstring | nullidintegerrequiredorg_idintegerrequiredfolder_uuidstringrequiredparent_folder_idinteger | nullorderintegercreation_datestringrequiredupdate_datestringrequiredtotal_itemsintegersubfoldersFolderRead[]Show child attributes
namestringrequiredpublicbooleandescriptionstring | nullthumbnail_imagestring | nullcolorstring | nullidintegerrequiredorg_idintegerrequiredfolder_uuidstringrequiredparent_folder_idinteger | nullorderintegercreation_datestringrequiredupdate_datestringrequiredtotal_itemsintegersubfoldersFolderRead[]Show child attributes
namestringrequiredpublicbooleandescriptionstring | nullthumbnail_imagestring | nullcolorstring | nullidintegerrequiredorg_idintegerrequiredfolder_uuidstringrequiredparent_folder_idinteger | nullorderintegercreation_datestringrequiredupdate_datestringrequiredtotal_itemsintegersubfoldersFolderRead[]itemsFolderContentItem[]breadcrumbsFolderBreadcrumb[]itemsFolderContentItem[]Show child attributes
resource_uuidstringrequiredresource_typestringrequiredpositionintegerresourceResourcerequiredbreadcrumbsFolderBreadcrumb[]Show child attributes
folder_uuidstringrequirednamestringrequireditemsFolderContentItem[]Show child attributes
resource_uuidstringrequiredresource_typestringrequiredpositionintegerresourceResourcerequiredbreadcrumbsFolderBreadcrumb[]Show child attributes
folder_uuidstringrequirednamestringrequiredusersUserRead[]requiredShow child attributes
usernamestringrequiredfirst_namestringrequiredlast_namestringrequiredemailstringrequiredavatar_imagestring | nullbiostring | nulldetailsDetails | nullprofileProfile | nullextra_metadataExtra Metadata | nullidintegerrequireduser_uuidstringrequiredemail_verifiedbooleanlast_login_atstring | nullsignup_methodstring | nullis_superadminbooleancommunitiesCommunityRead[]requiredShow child attributes
namestringrequireddescriptionstring | nullpublicbooleanthumbnail_imagestring | nullidintegerrequiredorg_idintegercourse_idinteger | nullcommunity_uuidstringrequiredmoderation_wordsstring[]moderation_settingsModeration Settings | nullcreation_datestringrequiredupdate_datestringrequireddiscussionsSearchDiscussionRead[]requiredShow child attributes
idintegerrequiredtitlestringrequiredcontentstring | nulllabelstring | nullemojistring | nullcommunity_idintegerorg_idintegerauthor_idintegerdiscussion_uuidstringrequiredupvote_countintegerrequirededit_countintegeris_pinnedbooleanis_lockedbooleancreation_datestringrequiredupdate_datestringrequiredcommunity_uuidstringplaygroundsPlaygroundRead[]requiredShow child attributes
namestringrequireddescriptionstring | nullthumbnail_imagestring | nullaccess_typePlaygroundAccessTypepublicauthenticatedrestrictedpublishedbooleancourse_uuidstring | nullhtml_contentstring | nullidintegerrequiredorg_idintegerrequiredorg_uuidstring | nullorg_slugstring | nullplayground_uuidstringrequiredcourse_idinteger | nullcreated_byinteger | nullauthor_usernamestring | nullauthor_first_namestring | nullauthor_last_namestring | nullauthor_user_uuidstring | nullauthor_avatar_imagestring | nullcreation_datestringrequiredupdate_datestringrequiredpodcastsPodcastRead[]requiredShow child attributes
namestringrequireddescriptionstring | nullaboutstring | nulltagsstring | nullthumbnail_imagestring | nullpublicbooleanrequiredpublishedbooleanidintegerrequiredorg_idintegerauthorsAuthorWithRole[]requiredShow child attributes
userUserReadrequiredShow child attributes
usernamestringrequiredfirst_namestringrequiredlast_namestringrequiredemailstringrequiredavatar_imagestring | nullbiostring | nulldetailsDetails | nullprofileProfile | nullextra_metadataExtra Metadata | nullidintegerrequireduser_uuidstringrequiredemail_verifiedbooleanlast_login_atstring | nullsignup_methodstring | nullis_superadminbooleanauthorshipResourceAuthorshipEnumrequiredCREATORCONTRIBUTORMAINTAINERREPORTERauthorship_statusResourceAuthorshipStatusEnumrequiredACTIVEPENDINGINACTIVEcreation_datestringrequiredupdate_datestringrequiredpodcast_uuidstringrequiredcreation_datestringrequiredupdate_datestringrequiredseoSeo | nulltotal_coursesintegertotal_foldersintegertotal_usersintegertotal_communitiesintegertotal_discussionsintegertotal_playgroundsintegertotal_podcastsintegerError responses
401Authentication required403User is not permitted to search this organization404Organization not found422Validation Error —HTTPValidationError
Request
Response
{
"courses": [
{
"name": "Example name",
"description": "An example description",
"about": "string",
"learnings": "string",
"tags": "string",
"thumbnail_type": "image",
"thumbnail_image": "string",
"thumbnail_video": "string",
"public": false,
"published": false,
"open_to_contributors": false,
"id": 1,
"org_id": 1,
"authors": [
{
"user": {
"username": null,
"first_name": null,
"last_name": null,
"email": null,
"avatar_image": null,
"bio": null,
"details": null,
"profile": null,
"extra_metadata": null,
"id": null,
"user_uuid": null,
"email_verified": null,
"last_login_at": null,
"signup_method": null,
"is_superadmin": null
},
"authorship": "CREATOR",
"authorship_status": "ACTIVE",
"creation_date": "string",
"update_date": "string"
}
],
"course_uuid": "string",
"creation_date": "string",
"update_date": "string",
"seo": {},
"extra_metadata": {}
}
],
"folders": [
{
"name": "Example name",
"public": true,
"description": "An example description",
"thumbnail_image": "string",
"color": "#0a0a0a",
"id": 1,
"org_id": 1,
"folder_uuid": "string",
"parent_folder_id": 1,
"order": 0,
"creation_date": "string",
"update_date": "string",
"total_items": 0,
"subfolders": [],
"items": [],
"breadcrumbs": []
}
],
"users": [
{
"username": "string",
"first_name": "Example name",
"last_name": "Example name",
"email": "ada@example.com",
"avatar_image": "string",
"bio": "string",
"details": {},
"profile": {},
"extra_metadata": {},
"id": 1,
"user_uuid": "string",
"email_verified": false,
"last_login_at": "string",
"signup_method": "string",
"is_superadmin": false
}
],
"communities": [
{
"name": "Example name",
"description": "An example description",
"public": true,
"thumbnail_image": "string",
"id": 1,
"org_id": 1,
"course_id": 1,
"community_uuid": "string",
"moderation_words": [],
"moderation_settings": {},
"creation_date": "string",
"update_date": "string"
}
],
"discussions": [
{
"id": 1,
"title": "Example title",
"content": "string",
"label": "string",
"emoji": "string",
"community_id": 1,
"org_id": 1,
"author_id": 1,
"discussion_uuid": "string",
"upvote_count": 0,
"edit_count": 0,
"is_pinned": false,
"is_locked": false,
"creation_date": "string",
"update_date": "string",
"community_uuid": ""
}
],
"playgrounds": [
{
"name": "Example name",
"description": "An example description",
"thumbnail_image": "string",
"access_type": "public",
"published": false,
"course_uuid": "string",
"html_content": "string",
"id": 1,
"org_id": 1,
"org_uuid": "string",
"org_slug": "my-example-slug",
"playground_uuid": "string",
"course_id": 1,
"created_by": 0,
"author_username": "string",
"author_first_name": "Example name",
"author_last_name": "Example name",
"author_user_uuid": "string",
"author_avatar_image": "string",
"creation_date": "string",
"update_date": "string"
}
],
"podcasts": [
{
"name": "Example name",
"description": "An example description",
"about": "string",
"tags": "string",
"thumbnail_image": "string",
"public": false,
"published": false,
"id": 1,
"org_id": 1,
"authors": [
{
"user": {
"username": null,
"first_name": null,
"last_name": null,
"email": null,
"avatar_image": null,
"bio": null,
"details": null,
"profile": null,
"extra_metadata": null,
"id": null,
"user_uuid": null,
"email_verified": null,
"last_login_at": null,
"signup_method": null,
"is_superadmin": null
},
"authorship": "CREATOR",
"authorship_status": "ACTIVE",
"creation_date": "string",
"update_date": "string"
}
],
"podcast_uuid": "string",
"creation_date": "string",
"update_date": "string",
"seo": {}
}
],
"total_courses": 0,
"total_folders": 0,
"total_users": 0,
"total_communities": 0,
"total_discussions": 0,
"total_playgrounds": 0,
"total_podcasts": 0
}