Contents
Schema #
The schema defines all the fields that exist within a course user record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
idinteger |
Unique identifier for the object. Read only Context: |
user_idsarray |
The user IDs. Limit 50 per request. Context: |
List Course Users #
Query this endpoint to retrieve a collection of course users. The response you receive can be controlled and filtered using the URL query parameters below.
Definition #
GET /ldlms/v1/sfwd-courses/<id>/users
Example Request #
$ curl https://example.com/wp-json/ldlms/v1/sfwd-courses/<id>/users
Arguments #
id |
Course ID. Required: 1 |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
fields |
Returned values.
Default: One of: |
exclude |
Ensure result set excludes specific IDs. |
include |
Limit result set to specific IDs. |
offset |
Offset the result set by a specific number of items. |
order |
Order sort attribute ascending or descending.
Default: One of: |
page |
Current page of the collection.
Default: |
per_page |
Maximum number of items to be returned in result set.
Default: |
search |
Limit results to those matching a string. |
roles |
Limit result set to users matching at least one specific role provided. Accepts csv list or single role. |
slug |
Limit result set to users with one or more specific slugs. |