Search for course tag groups
- 16 Jul 2024
- 1 Minute to read
- Print
Search for course tag groups
- Updated on 16 Jul 2024
- 1 Minute to read
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/SearchCourseTagGroups
Allows you to search for course tag groups.
Security
API Key
Header parameter nameapi_key
Query parameters
pageIndex
integer (int32)
A 0-based index of the paged results you wish to receive. In general, you should start with a value of zero and increment it as you need to retrieve additional results. If not supplied, a value of 0 is used (the first page of results).
pageSize
integer (int32)
Indicates how many results you want per page. if not supplied, a default value of 100 is used.
sort
string
The value you want to sort by. If not supplied, a default value of "Name" will be assumed. You can append " DESC" after the sort value to sort descending. For example, "Name DESC" would sort by name time in descending order. Possible values:
- Name
name
string
An optional parameter used to filter for course tag groups by name
Responses
200
OK Response
object
Status
integer (int32)
Indicates the status of the API request.
0 = Success
10 = Error
20 = Not found
30 = Invalid integration key
Example10
Error
string | null
Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).
TotalCount
integer (int32)
The total number of results that match the search conditions, not all of which may be in the current result set.
Example1
TotalPages
integer (int32)
The total number of result pages that match the search conditions.
Example1
Results
Array of object (CourseTagGroupSearchResult)
See CourseTagGroupSearchResult
object
Id
integer (int32)
The course tag group unique identifier
Example5678
Name
string | null
The course tag groups name
ExampleA Course Name
Tags
Array of object (Tag)
See Tag
object
Id
integer (int32)
The tag's unique identifier.
Example2
Name
string | null
The tag's name.
ExampleTag Example 1
Was this article helpful?