Contents
Schema #
The schema defines all the fields that exist within a group leaders 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.
id integer |
Unique identifier for the user. Read only Context: |
username string |
Login name for the user. Context: |
name string |
Display name for the user. Context: |
first_name string |
First name for the user. Context: |
last_name string |
Last name for the user. Context: |
email string, email |
The email address for the user. Context: |
url string, uri |
URL of the user. Context: |
description string |
Description of the user. Context: |
link string, uri |
Author URL of the user. Read only Context: |
locale string |
Locale for the user. Context: One of: |
nickname string |
The nickname for the user. Context: |
slug string |
An alphanumeric identifier for the user. Context: |
registered_date string, datetime (details) |
Registration date for the user. Read only Context: |
roles array |
Roles assigned to the user. Context: |
password string |
Password for the user (never included). Context: |
capabilities object |
All capabilities assigned to the user. Read only Context: |
extra_capabilities object |
Any extra capabilities assigned to the user. Read only Context: |
avatar_urls object |
Avatar URLs for the user. Read only Context: |
meta object |
Meta fields. Context: |
List Group Leaders #
Query this endpoint to retrieve a collection of group leaders. The response you receive can be controlled and filtered using the URL query parameters below.
Definition #
GET /ldlms/v2/groups/<id>/leaders
Example Request #
$ curl https://example.com/wp-json/ldlms/v2/groups/<id>/leaders
Arguments #
id |
Group ID Required: 1 |
context |
Scope under which the request is made; determines fields present in response.
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. |
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: |
orderby |
Sort collection by object attribute.
Default: One of: |
slug |
Limit result set to users with one or more specific slugs. |
roles |
Limit result set to users matching at least one specific role provided. Accepts csv list or single role. |
who |
Limit result set to users who are considered authors. One of: |