v2/Courses – LearnDash Dev Docs

Schema
List Courses
Create a Course
- Arguments
- Definition
List Courses
Update a Course
Delete a Course

Schema #

The schema defines all the fields that exist within a course 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`
`link` string, uri	URL to 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`
`permalink_template` string	Permalink template for the object. Read only Context: `edit`
`generated_slug` string	Slug automatically generated from the object title. Read only Context: `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`
`featured_media` integer	The ID of the featured media for the object. Context: `view`, `edit`, `embed`
`comment_status` string	Whether or not comments are open on the object. Context: `view`, `edit` One of: `open`, `closed`
`ping_status` string	Whether or not the object can be pinged. Context: `view`, `edit` One of: `open`, `closed`
`menu_order` integer	The order of the object in relation to other object of its type. Context: `view`, `edit`
`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_course_category` array	The terms assigned to the object in the ld_course_category taxonomy. Context: `view`, `edit`
`ld_course_tag` array	The terms assigned to the object in the ld_course_tag taxonomy. Context: `view`, `edit`
`materials_enabled` boolean	Materials Eabled Context: `view`, `edit`
`materials` string	Materials Context: `view`, `edit`
`certificate` integer	Course Certificate Context: `view`, `edit`
`disable_content_table` boolean	Disable Course Content Table Context: `view`, `edit`
`lessons_per_page` boolean	Custom Pagination Context: `view`, `edit`
`lesson_per_page_custom` integer	Lessons per page Context: `view`, `edit`
`topic_per_page_custom` integer	Topics per page Context: `view`, `edit`
`price_type` string	Course Price Type Context: `view`, `edit` One of: `open`, `closed`, `free`, `buynow`, `subscribe`
`price_type_paynow_price` string	Pay Now Course Price Context: `view`, `edit`
`price_type_subscribe_price` string	Subscribe Course Price Context: `view`, `edit`
`price_type_closed_price` string	Closed Course Price Context: `view`, `edit`
`price_type_closed_custom_button_url` string	Closed Course Button URL Context: `view`, `edit`
`prerequisite_enabled` boolean	Course Prerequisites Context: `view`, `edit`
`prerequisite_compare` string	Prerequisite Compare Mode. Context: `view`, `edit` One of: `ANY`, `ALL`
`prerequisites` array	Prerequisites. Context: `view`, `edit`
`points_enabled` boolean	Course Points Context: `view`, `edit`
`points_access` float	Required for Access Context: `view`, `edit`
`points_amount` float	Awarded on Completion Context: `view`, `edit`
`progression_disabled` boolean	Course Progression Disabled Context: `view`, `edit`
`expire_access` boolean	Course Access Expiration Context: `view`, `edit`
`expire_access_days` integer	Access Period Context: `view`, `edit`
`expire_access_delete_progress` boolean	Data Deletion Context: `view`, `edit`

List Courses #

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

Definition #

GET /ldlms/v2/sfwd-courses

Example Request #

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

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.
`modified_after`	Limit response to posts modified 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.
`modified_before`	Limit response to posts modified before a given ISO8601 compliant date.
`exclude`	Ensure result set excludes specific IDs.
`include`	Limit result set to specific IDs.
`menu_order`	Limit result set to posts with a specific menu_order value.
`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`, `menu_order`
`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 items with specific terms assigned in the categories taxonomy.
`categories_exclude`	Limit result set to items except those with specific terms assigned in the categories taxonomy.
`tags`	Limit result set to items with specific terms assigned in the tags taxonomy.
`tags_exclude`	Limit result set to items except those with specific terms assigned in the tags taxonomy.
`ld_course_category`	Limit result set to items with specific terms assigned in the ld_course_category taxonomy.
`ld_course_category_exclude`	Limit result set to items except those with specific terms assigned in the ld_course_category taxonomy.
`ld_course_tag`	Limit result set to items with specific terms assigned in the ld_course_tag taxonomy.
`ld_course_tag_exclude`	Limit result set to items except those with specific terms assigned in the ld_course_tag taxonomy.

Create a Course #

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.
`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.
`comment_status`	Whether or not comments are open on the object. One of: `open`, `closed`
`ping_status`	Whether or not the object can be pinged. One of: `open`, `closed`
`menu_order`	The order of the object in relation to other object of its type.
`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_course_category`	The terms assigned to the object in the ld_course_category taxonomy.
`ld_course_tag`	The terms assigned to the object in the ld_course_tag taxonomy.
`materials_enabled`	Materials Eabled
`materials`	Materials
`certificate`	Course Certificate
`disable_content_table`	Disable Course Content Table
`lessons_per_page`	Custom Pagination
`lesson_per_page_custom`	Lessons per page
`topic_per_page_custom`	Topics per page
`price_type`	Course Price Type Default: `open` One of: `open`, `closed`, `free`, `buynow`, `subscribe`
`price_type_paynow_price`	Pay Now Course Price
`price_type_subscribe_price`	Subscribe Course Price
`price_type_closed_price`	Closed Course Price
`price_type_closed_custom_button_url`	Closed Course Button URL
`prerequisite_enabled`	Course Prerequisites
`prerequisite_compare`	Prerequisite Compare Mode. Default: `ANY` One of: `ANY`, `ALL`
`prerequisites`	Prerequisites.
`points_enabled`	Course Points
`points_access`	Required for Access
`points_amount`	Awarded on Completion
`expire_access`	Course Access Expiration
`expire_access_days`	Access Period
`expire_access_delete_progress`	Data Deletion
`progression_disabled`	Course Progression Disabled

Definition #

POST /ldlms/v2/sfwd-courses

List Courses #

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

Definition #

GET /ldlms/v2/sfwd-courses/<id>

Example Request #

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

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.
`modified_after`	Limit response to posts modified 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.
`modified_before`	Limit response to posts modified before a given ISO8601 compliant date.
`exclude`	Ensure result set excludes specific IDs.
`include`	Limit result set to specific IDs.
`menu_order`	Limit result set to posts with a specific menu_order value.
`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`, `menu_order`
`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 items with specific terms assigned in the categories taxonomy.
`categories_exclude`	Limit result set to items except those with specific terms assigned in the categories taxonomy.
`tags`	Limit result set to items with specific terms assigned in the tags taxonomy.
`tags_exclude`	Limit result set to items except those with specific terms assigned in the tags taxonomy.
`ld_course_category`	Limit result set to items with specific terms assigned in the ld_course_category taxonomy.
`ld_course_category_exclude`	Limit result set to items except those with specific terms assigned in the ld_course_category taxonomy.
`ld_course_tag`	Limit result set to items with specific terms assigned in the ld_course_tag taxonomy.
`ld_course_tag_exclude`	Limit result set to items except those with specific terms assigned in the ld_course_tag taxonomy.

Update a Course #

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.
`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.
`comment_status`	Whether or not comments are open on the object. One of: `open`, `closed`
`ping_status`	Whether or not the object can be pinged. One of: `open`, `closed`
`menu_order`	The order of the object in relation to other object of its type.
`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_course_category`	The terms assigned to the object in the ld_course_category taxonomy.
`ld_course_tag`	The terms assigned to the object in the ld_course_tag taxonomy.
`materials_enabled`	Materials Eabled
`materials`	Materials
`certificate`	Course Certificate
`disable_content_table`	Disable Course Content Table
`lessons_per_page`	Custom Pagination
`lesson_per_page_custom`	Lessons per page
`topic_per_page_custom`	Topics per page
`price_type`	Course Price Type One of: `open`, `closed`, `free`, `buynow`, `subscribe`
`price_type_paynow_price`	Pay Now Course Price
`price_type_subscribe_price`	Subscribe Course Price
`price_type_closed_price`	Closed Course Price
`price_type_closed_custom_button_url`	Closed Course Button URL
`prerequisite_enabled`	Course Prerequisites
`prerequisite_compare`	Prerequisite Compare Mode. One of: `ANY`, `ALL`
`prerequisites`	Prerequisites.
`points_enabled`	Course Points
`points_access`	Required for Access
`points_amount`	Awarded on Completion
`expire_access`	Course Access Expiration
`expire_access_days`	Access Period
`expire_access_delete_progress`	Data Deletion
`progression_disabled`	Course Progression Disabled

Definition #

POST /ldlms/v2/sfwd-courses/<id>

Example Request #

Delete a Course #

Arguments #

force

Whether to bypass trash and force deletion.

Definition #

DELETE /ldlms/v2/sfwd-courses/<id>

Example Request #

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

Courses

Contents

Schema #

List Courses #

Definition #

Example Request #

Arguments #

Create a Course #

Arguments #

Definition #

List Courses #

Definition #

Example Request #

Arguments #

Update a Course #

Arguments #

Definition #

Example Request #

Delete a Course #

Arguments #

Definition #

Example Request #

The Most Trusted Online Course Platform for WordPress.