Skip to main content

ListLearners

GET https://shared-tp-api-test.30a.dev/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

Default Response

Schema
  • Array [
  • id string required

    Learner ID.

  • firstname object required
  • anyOf
  • string

    Learner first name.

  • lastname object required
  • anyOf
  • string

    Learner last name.

  • uniqueSystemIdentifier object required
  • anyOf
  • string

    Learner unique system ID.

  • email object required
  • anyOf
  • string

    Learner email.

  • phone object required
  • anyOf
  • string

    Learner phone.

  • created string required

    Learner creation date.

  • ]

    • Authorization

    name: Authorizationtype: apiKeyin: headerdescription: An Authorization Header with an auth-scheme of BLN including auth-params type, version, entity, key, token and secret. Example: `bln type=api, version=1, entity=user, key=<api-key>, token=<api-token>, secret=<api-secret>`

    Request

    Base URL
    https://shared-tp-api-test.30a.dev
    ApiKey
    training-provider-id — header required
    cursor — query
    limit — query
    skip — query
    name — query
    email — query
    curl / cURL
    curl -L -X GET 'https://shared-tp-api-test.30a.dev/tp-api/learners' \
    -H 'Accept: application/json' \
    -H 'Authorization: <API_KEY_VALUE>'
    Loading...