List LMS roles

get

https://{tenant}{.kallidus-suite.com}/api/v4/learn/roles

View all LMS roles.

Query Params

$filter

string

OData like filter expression. Supported operators: eq, and.
Supported fields: id, title.
Titles are matched exactly, not by substring; case sensitivity follows the tenant database collation.
Examples:

title eq 'Student'
id eq 10000000-0000-0000-0000-000000000007

$orderby

string

Order results by one or more fields. Use asc or desc for direction.
Supported fields: id, title.
When omitted, roles are returned in the LMS default order: access level, then title.
Example: title desc

$top

integer

0 to 100

Defaults to 100

Number of records to return (page size)

$count

boolean

Defaults to false

Include total count of matching records in response

$select

string

Comma-separated list of fields to include in response.
Supported fields: id, title, description.
Only the selected fields are returned for each role.
Example: id,title

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Roles retrieved successfully

400Bad Request

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

500Internal Server Error