The REST API V2 is current in beta. New endpoints are still being added and the parameters of existing endpoints may change.

Browse: Home / REST API Routes v2 /

User Course Progress Steps

Contents

Schema #

The schema defines all the fields that exist within a user course progress steps 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.

step
integer

Step ID

Read only

Context: embed, view
post_type
string

Post type for step

Read only

Context: view
progress_status
string

Course Progress Status

Read only

Context: embed, view

One of: not-started, in-progress, completed
date_started
string, null, datetime (details)

Date started

Read only

Context: view
date_completed
string, null, datetime (details)

Date completed

Read only

Context: view

Retrieve a User Course Progress Steps #

Definition & Example Request #

GET /ldlms/v2/users/<id>/course-progress/<course>/steps

Query this endpoint to retrieve a specific user course progress steps record.

$ curl https://example.com/wp-json/ldlms/v2/users/<id>/course-progress/<course>/steps

Sample Response #


		

		

			
				Expand code
			
		

	

	

			
Arguments #

	

		

							

					
													id

													
					
													
User ID

																			

								Required: 1
							

																									
				

							

					
													course

													
					
													
Unique Course identifier for the object.

																			

								Required: 1