ListLearners

GET /tp-api/learners

Retrieve a list of training provider learners for the given training provider.

Query Parameters

• cursor string

  Cursor to return items after a specific position in the list.

• limit integer

  Possible values: >= 1 and <= 100

  Default value: 10

  Maximum number of items to return.

• skip integer

  Query to retrieve the items starting from that position in the dataset.

• name string

  Filter by full name using case-insensitive partial match.

• email string

  Filter by the email address using case-insensitive partial match.

Header Parameters

• training-provider-id string required

Responses

• 200
• 400

---

Default Response

application/json

Schema

Schema

• Array [
• id string required

  Learner ID.

• firstname object required

  anyOf

  MOD1

  string

  Learner first name.

lastname object required

anyOf

MOD1

string

Learner last name.

uniqueSystemIdentifier object required

anyOf

MOD1

string

Learner unique system ID.

email object required

anyOf

MOD1

string

Learner email.

phone object required

anyOf

MOD1

string

Learner phone.

created string required

Learner creation date.

]