LMS Collaborator knowledge base

Home/Technical requirements/API/API - User import

API – User import

See API – Authorization

  • To import a single user, you need to send a POST request to the following URI /api/v2/users-import/single
  • The body of the request must contain a JSON object with information about the user.
  • The query must contain the headings Content-Type: application/json;charset=UTF-8 and Authorization: Bearer xxxxxx.

Request example:
curl 'https://your-domain.com/api/v2/users-import/single' -H 'Authorization: Bearer xxxxxx' -H 'Content-Type: application/json;charset=UTF-8' --data-binary '{"uid":"cl123456", "secondname":"Smith", "firstname":"John", "patronymic":"", "login":"john.smith", "email":"[email protected]", "password":"1", "birth_date":"26.07.1988", "gender":0, "is_active":1, "city":"Kiev", "department":"Dep1", "position":"CEO", "tags":"tag1,tag2", "phone":"0971111111"}'


Format of the object with user information

* Mandatory fields are marked with an asterisk

Field Type Description
uid* String Unique identifier
secondname* String Second name
firstname* String First name
patronymic String Third name
login* String Login
email* String Email
password* String Password
birth_date String Date of birth, in the format DD.MM.YYYYY or YYYY-MM-DD, for example 26.07.1988 or 1988-07-26
gender Number Gender, 0 - male, 1 - female, if the field is not set - it is ignored
is_active Number Checkbox indicating whether the user is enabled in the system, 1 - enabled, 0 - blocked
city String City
department String Department
position String Position
phone String Phone number, in international format, for example +380971234567
tags String Comma-separated list of tags
facebook_id String Facebook user id
google_id String Google user id
date_of_employment String Date of employment, in the format DD.MM.YYYY or YYYY-MM-DD, for example 26.07.1988 or 1988-07-26
work_contact String Working contacts
date_of_assignment_current_position String Date of current position assignment, in the format DD.MM.YYYY or YYYY-MM-DD, for example 26.07.1988 or 1988-07-26
structure_uid String Department code for automatic assignment of the user to a subdivision of the organizational structure
user_field1 String Additional field in the user profile
user_field2 String Additional field in the user profile
user_field3 String Additional field in the user profile
customInfo String can be not transmitted, additional field. Designed to transfer service information about the user in JSON format using BASE64 encoding. It is not displayed in the user's profile. Example of data that are encoded: {"projects":["mtr-1", "mto-232"], "vacation_days":21, "sick_leave_days":9}

Answer

  • In case of successful request (HTTP response code - 200), there will be reply in JSON format with information about number of processed records:
    {"created_count":1,"updated_count":0,"blocked_count":0,"unblocked_count":0}
  • In case of error (HTTP response code - 400) it returns JSON object with error information:
    {"error":"Required fields: uid, password, login, email, firstname, secondname, position"}
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