Groups

Schema #

The schema defines all the fields that exist within a groups 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.

date
string, null, datetime (details)

The date the object was published, in the site's timezone.

Context: view, edit, embed

date_gmt
string, null, datetime (details)

The date the object was published, as GMT.

Context: view, edit

guid
object

The globally unique identifier for the object.

Read only

Context: view, edit

id
integer

Unique identifier for the object.

Read only

Context: view, edit, embed

modified
string, datetime (details)

The date the object was last modified, in the site's timezone.

Read only

Context: view, edit

modified_gmt
string, datetime (details)

The date the object was last modified, as GMT.

Read only

Context: view, edit

slug
string

An alphanumeric identifier for the object unique to its type.

Context: view, edit, embed

status
string

A named status for the object.

Context: view, edit

One of: publish, future, draft, pending, private, graded, not_graded

type
string

Type of Post for the object.

Read only

Context: view, edit, embed

password
string

A password to protect access to the content and excerpt.

Context: edit

parent
integer

The ID for the parent of the object.

Context: view, edit

title
object

The title for the object.

Context: view, edit, embed

content
object

The content for the object.

Context: view, edit

author
integer

The ID for the author of the object.

Context: view, edit, embed

template
string

The theme file to use to display the object.

Context: view, edit

categories
array

The terms assigned to the object in the category taxonomy.

Context: view, edit

tags
array

The terms assigned to the object in the post_tag taxonomy.

Context: view, edit

ld_group_category
array

The terms assigned to the object in the ld_group_category taxonomy.

Context: view, edit

ld_group_tag
array

The terms assigned to the object in the ld_group_tag taxonomy.

Context: view, edit

materials_enabled
boolean

Materials Eabled

Context: view, edit

materials
string

Materials

Context: view, edit

certificate
integer

Group Certificate

Context: view, edit

disable_content_table
boolean

Group Content

Context: view, edit

courses_per_page_custom
integer

Courses per page

Context: view, edit

courses_orderby
string

Sort By

Context: view, edit

courses_order
string

Order Direction

Context: view, edit

price_type
string

Group Price Type

Context: view, edit

One of: closed, free, buynow, subscribe

price_type_paynow_price
string

Pay Now Group Price

Context: view, edit

price_type_subscribe_price
string

Subscribe Group Price

Context: view, edit

price_type_closed_price
string

Closed Group Price

Context: view, edit

price_type_closed_custom_button_url
string

Closed Group Button URL

Context: view, edit

List Groups #

Query this endpoint to retrieve a collection of groups. The response you receive can be controlled and filtered using the URL query parameters below.

Definition #

GET /ldlms/v2/groups

Example Request #

$ curl https://example.com/wp-json/ldlms/v2/groups

Arguments #

context

Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit

page

Current page of the collection.

Default: 1

per_page

Maximum number of items to be returned in result set.

Default: 10

search

Limit results to those matching a string.

after

Limit response to posts published after a given ISO8601 compliant date.

author

Limit result set to posts assigned to specific authors.

author_exclude

Ensure result set excludes posts assigned to specific authors.

before

Limit response to posts published before a given ISO8601 compliant date.

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: asc

One of: asc, desc

orderby

Sort collection by object attribute.

Default: title

One of: author, date, id, include, modified, parent, relevance, slug, include_slugs, title

parent

Limit result set to items with particular parent IDs.

parent_exclude

Limit result set to all items except those of a particular parent ID.

slug

Limit result set to posts with one or more specific slugs.

status

Limit result set to posts assigned one or more statuses.

Default: publish

tax_relation

Limit result set based on relationship between multiple taxonomies.

One of: AND, OR

categories

Limit result set to all items that have the specified term assigned in the categories taxonomy.

categories_exclude

Limit result set to all items except those that have the specified term assigned in the categories taxonomy.

tags

Limit result set to all items that have the specified term assigned in the tags taxonomy.

tags_exclude

Limit result set to all items except those that have the specified term assigned in the tags taxonomy.

ld_group_category

Limit result set to all items that have the specified term assigned in the ld_group_category taxonomy.

ld_group_category_exclude

Limit result set to all items except those that have the specified term assigned in the ld_group_category taxonomy.

ld_group_tag

Limit result set to all items that have the specified term assigned in the ld_group_tag taxonomy.

ld_group_tag_exclude

Limit result set to all items except those that have the specified term assigned in the ld_group_tag taxonomy.

Create a Groups #

Arguments #

date

The date the object was published, in the site's timezone.

date_gmt

The date the object was published, as GMT.

slug

An alphanumeric identifier for the object unique to its type.

status

A named status for the object.

One of: publish, future, draft, pending, private, graded, not_graded

password

A password to protect access to the content and excerpt.

parent

The ID for the parent of the object.

title

The title for the object.

content

The content for the object.

author

The ID for the author of the object.

featured_media

The ID of the featured media for the object.

template

The theme file to use to display the object.

categories

The terms assigned to the object in the category taxonomy.

tags

The terms assigned to the object in the post_tag taxonomy.

ld_group_category

The terms assigned to the object in the ld_group_category taxonomy.

ld_group_tag

The terms assigned to the object in the ld_group_tag taxonomy.

materials_enabled

Materials Eabled

materials

Materials

certificate

Group Certificate

disable_content_table

Group Content

courses_per_page_custom

Courses per page

courses_orderby

Sort By

courses_order

Order Direction

price_type

Group Price Type

Default: open

One of: closed, free, buynow, subscribe

price_type_paynow_price

Pay Now Group Price

price_type_subscribe_price

Subscribe Group Price

price_type_closed_price

Closed Group Price

price_type_closed_custom_button_url

Closed Group Button URL

Definition #

POST /ldlms/v2/groups

List Groups #

Query this endpoint to retrieve a collection of groups. The response you receive can be controlled and filtered using the URL query parameters below.

Definition #

GET /ldlms/v2/groups/<id>

Example Request #

$ curl https://example.com/wp-json/ldlms/v2/groups/<id>

Arguments #

id

Unique identifier for the object.

context

Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit

page

Current page of the collection.

Default: 1

per_page

Maximum number of items to be returned in result set.

Default: 10

search

Limit results to those matching a string.

after

Limit response to posts published after a given ISO8601 compliant date.

author

Limit result set to posts assigned to specific authors.

author_exclude

Ensure result set excludes posts assigned to specific authors.

before

Limit response to posts published before a given ISO8601 compliant date.

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: asc

One of: asc, desc

orderby

Sort collection by object attribute.

Default: title

One of: author, date, id, include, modified, parent, relevance, slug, include_slugs, title

parent

Limit result set to items with particular parent IDs.

parent_exclude

Limit result set to all items except those of a particular parent ID.

slug

Limit result set to posts with one or more specific slugs.

status

Limit result set to posts assigned one or more statuses.

Default: publish

tax_relation

Limit result set based on relationship between multiple taxonomies.

One of: AND, OR

categories

Limit result set to all items that have the specified term assigned in the categories taxonomy.

categories_exclude

Limit result set to all items except those that have the specified term assigned in the categories taxonomy.

tags

Limit result set to all items that have the specified term assigned in the tags taxonomy.

tags_exclude

Limit result set to all items except those that have the specified term assigned in the tags taxonomy.

ld_group_category

Limit result set to all items that have the specified term assigned in the ld_group_category taxonomy.

ld_group_category_exclude

Limit result set to all items except those that have the specified term assigned in the ld_group_category taxonomy.

ld_group_tag

Limit result set to all items that have the specified term assigned in the ld_group_tag taxonomy.

ld_group_tag_exclude

Limit result set to all items except those that have the specified term assigned in the ld_group_tag taxonomy.

Update a Groups #

Arguments #

id

Unique identifier for the object.

date

The date the object was published, in the site's timezone.

date_gmt

The date the object was published, as GMT.

slug

An alphanumeric identifier for the object unique to its type.

status

A named status for the object.

One of: publish, future, draft, pending, private, graded, not_graded

password

A password to protect access to the content and excerpt.

parent

The ID for the parent of the object.

title

The title for the object.

content

The content for the object.

author

The ID for the author of the object.

featured_media

The ID of the featured media for the object.

template

The theme file to use to display the object.

categories

The terms assigned to the object in the category taxonomy.

tags

The terms assigned to the object in the post_tag taxonomy.

ld_group_category

The terms assigned to the object in the ld_group_category taxonomy.

ld_group_tag

The terms assigned to the object in the ld_group_tag taxonomy.

materials_enabled

Materials Eabled

materials

Materials

certificate

Group Certificate

disable_content_table

Group Content

courses_per_page_custom

Courses per page

courses_orderby

Sort By

courses_order

Order Direction

price_type

Group Price Type

One of: closed, free, buynow, subscribe

price_type_paynow_price

Pay Now Group Price

price_type_subscribe_price

Subscribe Group Price

price_type_closed_price

Closed Group Price

price_type_closed_custom_button_url

Closed Group Button URL

Definition #

POST /ldlms/v2/groups/<id>

Example Request #

Delete a Groups #

Arguments #

id

Unique identifier for the object.

force

Whether to bypass trash and force deletion.

Definition #

DELETE /ldlms/v2/groups/<id>

Example Request #

$ curl -X DELETE https://example.com/wp-json/ldlms/v2/groups/<id>