LMS Collaborator knowledge base

Home/Technical requirements/API/API - User List

API – User List

See API – Authorization

  • To get the list of users you need to send GET request to the following URI /api/v2/users/list.
  • The request must contain the headings Content-Type: application/json;charset=UTF-8 and Authorization: Bearer xxxxxx.

Request example:
curl 'http://localhost:8080/api/v2/users/list' -H 'Authorization: Bearer xxxxxx' -H 'Content-Type: application/json;charset=UTF-8'


In case of successful request (HTTP response code - 200), there will be reply in JSON format with information about number of records in the pager field
and an array of data in the data field

The query supports filtering by the following fields:

  • fullname- (Fullname or email or login)
  • position- Position
  • department - Departmaent
  • city- City
  • tags - User tags

Example of a query with an email search:
curl 'http://localhost:8080/api/v2/users/list?filter[fullname][email protected]

Still have questions?
Our technical support team is always happy to help!
Write to us at technical support [email protected]. If you are registered on our Helpdesk - send request button below.
Send request