List all enrollments

get

https://app.360learning.com/api/v2/paths/{pathId}/enrollments

🔑
Required OAuth scope: paths:read.

📖
This endpoint is paginated with a page size of 5,000 enrollments. For more information, see the Pagination guide.

Lists all enrollments for the given path.

Path Params

pathId

string

required

^[a-fA-F0-9]{24}$

The unique ID of the path.

Query Params

status

object

Filter on status property with LHS bracket notation.

Expected value format is a string (archived, published).

createdAt

object

Filter on createdAt property with LHS bracket notation.

Expected value format is a date (YYYY-MM-DDThh:mm:ss.sssZ). The milliseconds are always set to 0.

modifiedAt

object

Filter on modifiedAt property with LHS bracket notation.

Expected value format is a date (YYYY-MM-DDThh:mm:ss.sssZ). The milliseconds are always set to 0.

sessionId

object

Filter on sessionId property with LHS bracket notation.

Expected value format is a valid ID (24 digits or letters).

Headers

360-api-version

string

enum

required

The version of the API.

Allowed:

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns one page of 5000 enrollments.