### GET /manage/v1/user/menu Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/user/menu ```markdown ### Responses #### 200 - Operation Successful Empty response body #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/user/menu" ``` ``` -------------------------------- ### GET /manage/v1/site/bootstrap Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/site/bootstrap ```markdown ### Parameters - **theme** (string, query, optional): The theme code to preview. If passed, the returned branding_elements will be loaded based on this value, rather than the active theme ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/site/bootstrap?theme=value" ``` ``` -------------------------------- ### GET /manage/v1/site/microservice Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/site/microservice ```markdown ### Responses #### 200 - Operation Successful Empty response body #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/site/microservice" ``` ``` -------------------------------- ### GET /manage/v1/site/helpdesk/settings Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/site/helpdesk/settings ```markdown ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/site/helpdesk/settings" ``` ``` -------------------------------- ### GET /manage/v1/theme Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/theme ```markdown ### Responses #### 200 - Operation Successful Empty response body #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/theme " ``` ``` -------------------------------- ### GET /manage/v1/users/events/download Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/users/events/download ```markdown ### Parameters - **id** (string, query, optional): The user ID. If not set, it's the logged-in user's ID. - **token** (string, query, optional): The hash for the user. - **start_date** (string, query, optional): Filter events after this date. Default: 1900-01-01 - **end_date** (string, query, optional): Filter events before this date. Default: 9999-12-31 ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/users/events/download?id=value&token=value&start_date=value&end_date=value" ``` ``` -------------------------------- ### GET /manage/v1/user/activities Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/user/activities ```markdown ### Parameters - **id_user** (string, query, optional): ID of the user. If not provided - current logged user will be used - **activities** (string, query, required): Array contains what activity should be returned. ( For example: 'sessions', 'enrollments', 'course_enrollments', 'best_score_in_classroom' ) - **timeframe** (string, query, required): Time range for activity statistic ### Responses #### 200 - Operation Successful Empty response body #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/user/activities?id_user=value&activities=value&timeframe=value" ``` ``` -------------------------------- ### GET /manage/v1/player/license Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/player/license ```markdown ### Responses #### 200 - Operation Successful Empty response body #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/player/license" ``` ``` -------------------------------- ### GET /manage/v1/optin Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/optin ```markdown ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/optin" ``` ``` -------------------------------- ### GET /manage/v1/mobile/bootstrap Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/mobile/bootstrap ```markdown ### Responses #### 200 - Operation Successful Empty response body #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/mobile/bootstrap" ``` ``` -------------------------------- ### GET /manage/v1/termsandconditions/current Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/termsandconditions/current ```markdown ### Parameters - **client_id** (string, query, optional): A multidomain client ID ### Responses #### 200 - Operation Successful Empty response body #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/termsandconditions/current?client_id=value" ``` ``` -------------------------------- ### GET /manage/v1/termsandconditions/default Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/termsandconditions/default ```markdown ### Responses #### 200 - Operation Successful Empty response body #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/termsandconditions/default" ``` ``` -------------------------------- ### GET /manage/v1/termsandconditions/multidomains Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/termsandconditions/multidomains ```markdown ### Parameters - **search_text** (string, query, optional): Search text in the client name. - **tc_id** (string, query, optional): Check if the clients are assigned to this terms and conditions - **get_only_assigned** (string, query, optional): Get the clients which are already assigned to the requested terms and conditions - **sort_attr** (string, query, optional): Sort by this field, default value - name. Options: id, name - **sort_dir** (string, query, optional): Sorting Direction: asc = Ascending, desc = descending, default - asc ### Responses #### 200 - Operation Successful Empty response body #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/termsandconditions/multidomains?search_text=value&tc_id=value&get_only_assigned=value&sort_attr=value&sort_dir=value" ``` ``` -------------------------------- ### GET /manage/v1/termsandconditions Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/termsandconditions ```markdown ### Parameters - **search_text** (string, query, optional): Search text in the T&C record name. - **sort_attr** (string, query, optional): Sort by this field, default value - name. Options: id, name, last_updated - **sort_dir** (string, query, optional): Sorting Direction: asc = Ascending, desc = descending, default - asc - **search_text** (string, query, optional): Text to search in id, name, default, multidomains, last_updated, version - **filters** (string, query, optional): Serialized object containing list of filters and their options - ( field:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains} ) ### Responses #### 200 - Operation Successful Empty response body #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/termsandconditions?search_text=value&sort_attr=value&sort_dir=value&search_text=value&filters=value" ``` ``` -------------------------------- ### GET /manage/v1/gamification/summary Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/gamification/summary ```markdown ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/gamification/summary" ``` ``` -------------------------------- ### GET /manage/v1/oauth2/client Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/oauth2/client ```markdown ### Parameters - **sort_attr** (string, query, optional): Sort by this field, default value - client_id. Possible values: client_id, app_name - **sort_dir** (string, query, optional): Sorting Direction: asc = Ascending, desc = descending, default - asc - **page** (string, query, optional): Page to return, default 1 - **page_size** (string, query, optional): Maximum number of results per page, default 50 - **cursor** (string, query, optional): Data set navigational cursor previously obtained by passing get_cursor=1 - **get_cursor** (string, query, optional): Generate and return cursor and prebuilt navigational _links. Default is 0 ### Responses #### 200 - Operation Successful Empty response body #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/oauth2/client?sort_attr=value&sort_dir=value&page=value&page_size=value&cursor=value&get_cursor=value" ``` ``` -------------------------------- ### GET /manage/v1/unsplash Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/unsplash ```markdown ### Parameters - **search_text** (string, query, optional): Search text for the photos - **page** (string, query, optional): Get specific page result. Default 1 - **page_size** (string, query, optional): Get certain number of items per page. Default 10 ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/unsplash?search_text=value&page=value&page_size=value" ``` ``` -------------------------------- ### GET /manage/v1/theme/{theme_code} Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/theme/{theme_code} ```markdown ### Parameters - **theme_code** (string, path, required): Identification code of the theme. ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/theme/{theme_code} " ``` ``` -------------------------------- ### GET /manage/v1/enrollment_rules Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/enrollment_rules ```markdown ### Parameters - **page** (string, query, optional): Page to return, default 1 - **page_size** (string, query, optional): Maximum number of results per page. The default size is defined in Advanced Settings page (Set the amount of elements you want to display in each page) - **cursor** (string, query, optional): Data set navigational cursor previously obtained by passing get_cursor=1 - **get_cursor** (string, query, optional): Generate and return "cursor" and prebuilt navigational "_links". 1 is enabled, 0 disabled. Default is 0. - **search_text** (string, query, optional): Search string to filter enrollment rules by titles. - **sort_attr** (string, query, optional): Sort by this field, default value - title - **sort_dir** (string, query, optional): Sorting Direction: asc = Ascending, desc = descending, default - desc ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/enrollment_rules?page=value&page_size=value&cursor=value&get_cursor=value&search_text=value&sort_attr=value&sort_dir=value" ``` ``` -------------------------------- ### GET /manage/v1/importer/get_csv_sample_data Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/importer/get_csv_sample_data ```markdown ### Parameters - **filename** (string, query, required): S3 filename of the uploaded CSV. If a path is passed, only the filename will be taken - **delimiter** (string, query, optional): The delimiter used to separate the fields in a row. Default is "," - **charset** (string, query, required): The used character set for the CSV file. Supported charsets: 'Windows-1252', 'BIG-5' and 'UTF-8' - **skip_first_row** (string, query, required): Will the first line contain the column names ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/importer/get_csv_sample_data?filename=value&delimiter=value&charset=value&skip_first_row=value" ``` ``` -------------------------------- ### GET /manage/v1/multidomain Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/multidomain ```markdown ### Parameters - **domain_type** (string, query, optional): Allows to filter the multidomain by their type - **sort_attr** (string, query, optional): Sort by this field, default value - name. Options: name, id - **sort_dir** (string, query, optional): Sorting Direction: asc = Ascending, desc = descending, default - asc - **page** (string, query, optional): Page to return, default 1 - **page_size** (string, query, optional): Maximum number of results per page, default 10, if value is -1 -> all items are displayed - **client_ids** (string, query, optional): Limit the results to include data only for the specified client IDs - **search_text** (string, query, optional): Text to search in the name of the domains - **search_text_exclude_root** (string, query, optional): Exclude root domain from search query - **client_domains** (string, query, optional): The list of domains to use to filter the results of the search. An empty string in the list will return the main domain - **include_disabled** (string, query, optional): When true, disabled multidomains will be returned too (default - false) ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/multidomain?domain_type=value&sort_attr=value&sort_dir=value&page=value&page_size=value&client_ids=value&search_text=value&search_text_exclude_root=value&client_domains=value&include_disabled=value" ``` ``` -------------------------------- ### GET /manage/v1/auth0/settings Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/auth0/settings ```markdown ### Parameters - **id_multidomain** (string, query, optional): id of desired multidomain /if any/ ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/auth0/settings?id_multidomain=value" ``` ``` -------------------------------- ### GET /manage/v1/enrollment_rules_logs Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/enrollment_rules_logs ```markdown ### Parameters - **page** (string, query, optional): Page to return, default 1 - **page_size** (string, query, optional): Maximum number of results per page. The default size is defined in Advanced Settings page (Set the amount of elements you want to display in each page) - **cursor** (string, query, optional): Data set navigational cursor previously obtained by passing get_cursor=1 - **get_cursor** (string, query, optional): Generate and return "cursor" and prebuilt navigational "_links". 1 is enabled, 0 disabled. Default is 0. - **search_text** (string, query, optional): Search string to filter enrollment rules by titles. - **rule_type** (string, query, optional): Search logs for rule type - **rule_log_from** (string, query, optional): Search logs from time - **rule_log_to** (string, query, optional): Search logs to time - **sort_attr** (string, query, optional): Sort by this field, default value - enrollment_rule_id. Options: none (default), date_created, title - **sort_dir** (string, query, optional): Sorting Direction: asc = Ascending, desc = descending, default - desc ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/enrollment_rules_logs?page=value&page_size=value&cursor=value&get_cursor=value&search_text=value&rule_type=value&rule_log_from=value&rule_log_to=value&sort_attr=value&sort_dir=value" ``` ``` -------------------------------- ### GET /manage/v1/mobile/settings Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/mobile/settings ```markdown ### Parameters - **multidomain_id** (string, query, optional): ID of a multidomain for which to view the setting's value. ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/mobile/settings ?multidomain_id=value" ``` ``` -------------------------------- ### API Overview: Manage Source: https://doceboapi.docebosaas.com/manage/v1/swagger OpenAPI specification version 1.0 ```yaml # Manage # Version: 1.0 OpenAPI specification # Base URL: Not specified ``` -------------------------------- ### GET /manage/v1/workforce/skills Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/workforce/skills ```markdown ### Parameters - **search** (string, query, optional): Search term - **occupation_code** (string, query, optional): Occupation Code - **size** (string, query, optional): Max Number of returning item. (default 20) - **skip_skillgroup** (string, query, optional): If passed, skillgroup filter will be ignored. Available to SuperAdmins only. Default=false ### Responses #### 200 - Operation Successful Empty response body #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/workforce/skills?search=value&occupation_code=value&size=value&skip_skillgroup=value" ``` ``` -------------------------------- ### GET /manage/v1/clickjacking/whitelist Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/clickjacking/whitelist ```markdown ### Responses #### 200 - Operation Successful Empty response body #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/clickjacking/whitelist" ``` ``` -------------------------------- ### GET /manage/v1/managers/learningplans Source: https://doceboapi.docebosaas.com/manage/v1/swagger Only users with manager permission can call this API
Only learning plans which are not for sale will be returned ```markdown ### Parameters - **user_id** (string, query, optional): Must be Subordinate ID of existing, active and not expired user, with at least 1 Active (confirmed or import) relation of any level with the current manager. When passed and if the user is already enrolled the item will not appear in the list. - **search_text** (string, query, optional): Search all string fields for this value ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/managers/learningplans?user_id=value&search_text=value" ``` ``` -------------------------------- ### GET /manage/v1/user/levels Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/user/levels ```markdown ### Responses #### 200 - Operation Successful Empty response body #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/user/levels" ``` ``` -------------------------------- ### GET /manage/v1/contentpartners Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/contentpartners ```markdown ### Parameters - **cursor** (string, query, optional): For pagination - **sort_attr** (string, query, optional): Sort by this field, default value - id. - **sort_dir** (string, query, optional): Sorting Direction: asc = Ascending, desc = descending, default - desc - **page** (string, query, optional): Page to return, default 1 - **page_size** (string, query, optional): Maximum number of results per page, default 20 - **search_text** (string, query, optional): Text to search in content partners name - **active** (string, query, optional): Filters the list by active and non-active content partners. If passed as true, the result contains only active content partners and if passed as false - non-active. ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/contentpartners?cursor=value&sort_attr=value&sort_dir=value&page=value&page_size=value&search_text=value&active=value" ``` ``` -------------------------------- ### POST /manage/v1/user/quick_registration Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for POST /manage/v1/user/quick_registration ```markdown ### Parameters - **body** (ManageUserQuickRegistrationSchema, body, optional): Raw Body ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X POST "https://api.example.com/manage/v1/user/quick_registration" ``` ``` -------------------------------- ### GET /manage/v1/channels Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/channels ```markdown ### Parameters - **search** (string, query, optional): Search channels by specific key - **page** (string, query, optional): Page to return, default 1 - **page_size** (string, query, optional): Maximum number of results per page, default: platform dependant - **ignore_system_channels** (string, query, optional): Ignore system channels - 1, Include system channels - 0; Default: 1 - **count_user** (string, query, optional): Return channel users count - 1, No channels users count - 0; Default: 0 - **include_ai_channels** (string, query, optional): Return AI channels if profiled - 1, No AI channels - 0; Default: 0 - **hide_empty_channels** (string, query, optional): If true, show only channels that have content - **only_followed_channels** (string, query, optional): If true, show only channels that are followed by me - **channel_ids** (string, query, optional): The array containing channel IDs ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/channels?search=value&page=value&page_size=value&ignore_system_channels=value&count_user=value&include_ai_channels=value&hide_empty_channels=value&only_followed_channels=value&channel_ids=value" ``` ``` -------------------------------- ### GET /manage/v1/user/managers Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/user/managers ```markdown ### Parameters - **search_text** (string, query, optional): Search all string fields for this value - **relation_ids** (string, query, optional): Filter by ids of the manager subordinate relation records - **manager_ids** (string, query, optional): Filter by ids of the managers - **manager_type_ids** (string, query, optional): Filter by ids of the manager types - **manager_type_statuses** (string, query, optional): Filter by statuses Possible values ('confirmed', 'not_confirmed', 'pending', 'imported') ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/user/managers?search_text=value&relation_ids=value&manager_ids=value&manager_type_ids=value&manager_type_statuses=value" ``` ``` -------------------------------- ### POST /manage/v1/managers/learningplans/enrollments/batch Source: https://doceboapi.docebosaas.com/manage/v1/swagger IF there are any errors related to the Additional Enrollment Fields, i.e invalid data structure for that param, incorrect values passed OR missing mandatory fields FOR certain course, we are NOT going to enroll the user neither to any of the courses or the LP itself ```markdown ### Parameters - **body** (ManageManagerLearningplanEnrollBatchSchema, body, optional): Raw Body ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X POST "https://api.example.com/manage/v1/managers/learningplans/enrollments/batch" ``` ``` -------------------------------- ### GET /manage/v1/user/export Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/user/export ```markdown ### Parameters - **user_ids** (string, query, required): User IDs to be exported - **additional_field_ids** (string, query, optional): Additional fields IDs to be included in export - **user_id** (string, query, optional): If user ID must be included in export - **username** (string, query, optional): If username must be included in export - **first_name** (string, query, optional): If user first name must be included in export - **last_name** (string, query, optional): If user last name must be included in export - **email** (string, query, optional): If user email must be included in export - **uuid** (string, query, optional): If user uuid must be included in export - **is_manager** (string, query, optional): If user is a manager must be included in export - **creation_date** (string, query, optional): If user creation date must be included in export - **expiration_date** (string, query, optional): If user expiration date must be included in export - **email_validation_status** (string, query, optional): If user email validation status must be included in export - **last_access_date** (string, query, optional): If user last access date must be included in export - **language** (string, query, optional): If language must be included in export - **include_header** (string, query, optional): Include or NOT naming of columns in csv/xls file - **export_format** (string, query, optional): Format of exported file csv/xls file. Options: "csv" or "xls". Default: "xls" - **delimiter** (string, query, optional): Delimiter for exported csv file/ Default: "," - **level** (string, query, optional): If user level must be included in export - **managers** (string, query, optional): List of Manager Types IDs to be exported - **send_notification** (string, query, optional): If user send notification must be included in export - **authenticatorapp_paired** (string, query, optional): If user has paired authenticator app. The API accepts this parameter only if EsignatureApp is activated, enabled and AuthenticatorApp setting is checked ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/user/export?user_ids=value&additional_field_ids=value&user_id=value&username=value&first_name=value&last_name=value&email=value&uuid=value&is_manager=value&creation_date=value&expiration_date=value&email_validation_status=value&last_access_date=value&language=value&include_header=value&export_format=value&delimiter=value&level=value&managers=value&send_notification=value&authenticatorapp_paired=value" ``` ``` -------------------------------- ### GET /manage/v1/user/importer_fields Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/user/importer_fields ```markdown ### Responses #### 200 - Operation Successful Empty response body #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/user/importer_fields" ``` ``` -------------------------------- ### POST /manage/v1/site/helpDesk Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for POST /manage/v1/site/helpDesk ```markdown ### Parameters - **body** (ManageSiteHelpDeskSchema, body, optional): Raw Body ### Responses #### 200 - Operation Successful Empty response body #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X POST "https://api.example.com/manage/v1/site/helpDesk" ``` ``` -------------------------------- ### GET /manage/v1/user/check_validity Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/user/check_validity ```markdown ### Parameters - **userid** (string, query, optional): Username - **email** (string, query, optional): Email - **uuid** (string, query, optional): UUID ### Responses #### 200 - Operation Successful Empty response body #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/user/check_validity?userid=value&email=value&uuid=value" ``` ``` -------------------------------- ### GET /manage/v1/importer/download_csv_sample/{type} Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/importer/download_csv_sample/{type} ```markdown ### Parameters - **type** (string, path, required): Type of the CSV sample ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/importer/download_csv_sample/{type}" ``` ``` -------------------------------- ### GET /manage/v1/user/keep_alive Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/user/keep_alive ```markdown ### Responses #### 200 - Operation Successful Empty response body #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/user/keep_alive" ``` ``` -------------------------------- ### GET /manage/v1/importer/preset/{type} Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/importer/preset/{type} ```markdown ### Parameters - **type** (string, path, required): The group name ### Responses #### 200 - Operation Successful Empty response body #### 400 - General Error General Error #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/importer/preset/{type}" ``` ``` -------------------------------- ### GET /manage/v1/user/session Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/user/session ```markdown ### Parameters - **referral_id** (string, query, optional): Referral ID of a content partner - **theme** (string, query, optional): The theme code to preview. If passed, the returned branding_elements will be loaded based on this value, rather than the active theme ### Responses #### 200 - Operation Successful Empty response body #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/user/session?referral_id=value&theme=value" ``` ``` -------------------------------- ### GET /manage/v1/user/list Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/user/list ```markdown ### Parameters - **branch_ids** (string, query, optional): Filter the results to only these branch IDs (and their descendants). NOTE: this parameter can't be set in the api browser page, a direct call can be made using a query string similar to this: (base-url)/manage/v1/user/list?branch_ids[0][id]=1&branch_ids[0][include_descendants]=true - **group_ids** (string, query, optional): Filter the results by users that are members of the group IDs - **user_ids** (string, query, optional): User IDs for which we want to retrieve metadata/fields - **expand** (string, query, optional): Comma separated list of 'fields' which should be included in the API response for each item. Future use cases might introduce support for other fields that can be returned. For now the available fields are : id, username, firstname, lastname, email, uuid and avatar. Default value: id - **page** (string, query, optional): Page to return, default 1 - **page_size** (string, query, optional): Maximum number of results per page, default 20 - **include_inactive** (string, query, optional): Include inactive users - **active** (string, query, optional): If true show only active not expired users - **start_from** (string, query, optional): If provided should return all users with id bigger than provided integer value. Default 0. ### Responses #### 200 - Operation Successful Empty response body #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/user/list?branch_ids=value&group_ids=value&user_ids=value&expand=value&page=value&page_size=value&include_inactive=value&active=value&start_from=value" ``` ``` -------------------------------- ### GET /manage/v1/user Source: https://doceboapi.docebosaas.com/manage/v1/swagger API endpoint for GET /manage/v1/user ```markdown ### Parameters - **pending** (string, query, optional): Get "pending" users OR all others. Options: 0 - false, 1 - true. Default value: false - **branch_id** (string, query, optional): Filtering by branch ID - **selection_status** (string, query, optional): Branches with children or not. Options: 1 - without children, 2 - with children. Default: 1 - **minimalistic** (string, query, optional): If true, does not return some additional information in each user record. Use this for better performances. Default: false - **newsletter_optout** (string, query, optional): If true, return only opt-out users and vice versa. Default: false. - **sort_attr** (string, query, optional): Sort by this field, default value - first_name. Options: none (no sorting), username, first_name, last_name, status, level, email, last_access_date, expiration_date, language, email_validation_status, manager_1 (where 1 is manager type ID), authenticatorapp_pair_date - **sort_dir** (string, query, optional): Sorting Direction: asc = Ascending, desc = descending, default - desc - **page** (string, query, optional): Page to return, default 1 - **page_size** (string, query, optional): Maximum number of results per page (upper bound 200). Default value: uses value of the advanced setting "Amount of elements to display in each page". - **get_total_count** (string, query, optional): If 1 the count of found items will be returned. Options: 0, 1 default 0 - **match_type** (string, query, optional): should perform a full match for the username or partial match for the firstname, lastname, username and email altogether, using the "search_text" parameter, possible values ("full", "partial"), default = "partial" - **search_text** (string, query, optional): Text to search in first name, last name, email and username of the users. To search for special characters we suggest to use a URL encoding, to be sure the characters will be correctly recognize (for example: user+name encoded user%2Bname) - **filters** (string, query, optional): serialize object containing list of filters and their options. List of filters - ( code:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains}, sold_to:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains}, bundle_name:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains}, plan_name:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains} ) - **exclude** (string, query, optional): List of user IDs to exclude from result - **exclude_power_users_and_super_admins** (string, query, optional): Exclude all power users and super admins from result. Default: disabled - **cursor** (string, query, optional): Data set navigational cursor previosuly obtained by passing get_cursor=1 - **get_cursor** (string, query, optional): Generate and return "cursor" and prebuilt navigational "_links". Default=0 - **slack_id** (string, query, optional): Slack ID used to filter the result user - **active** (string, query, optional): If true show only active not expired users - **search_additional_field_id** (string, query, optional): If given, filters users by the specified additional field. - **search_additional_field_value** (string, query, optional): The additional field value to filter users with. The additional field is indicated by 'search_additional_field_id'. - **not_paginated** (string, query, optional): If true will return the results not paginated - **include_user** (string, query, optional): If true will return the results with the current user; Default: false - **updated_from** (string, query, optional): If provided, the API will return only users updated after the given datetime (in yyyy-MM-dd hh:mm:ss format) - **get_currently_logged_users_count** (string, query, optional): If true the count of found items will be returned. Default false - **use_starts_with** (string, query, optional): If true, the text search on the firstname, lastname, username and email fields uses the "starts with" logic instead of the default "contains" logic. IMPORTANT NOTE: when set to true, only the fields firstname, lastname, username and email are searched. ### Responses #### 200 - Operation Successful Empty response body #### 401 - Your request was made with invalid credentials. Your request was made with invalid credentials. #### 403 - Permission denied Permission denied #### 500 - Internal server error Internal server error ### Example Usage ```bash curl -X GET "https://api.example.com/manage/v1/user?pending=value&branch_id=value&selection_status=value&minimalistic=value&newsletter_optout=value&sort_attr=value&sort_dir=value&page=value&page_size=value&get_total_count=value&match_type=value&search_text=value&filters=value&exclude=value&exclude_power_users_and_super_admins=value&cursor=value&get_cursor=value&slack_id=value&active=value&search_additional_field_id=value&search_additional_field_value=value¬_paginated=value&include_user=value&updated_from=value&get_currently_logged_users_count=value&use_starts_with=value" ``` ```