Справка

Сотрудники

Облачный Pyrus
Безоблачный Pyrus

Методы позволяют добавлять сотрудников в вашу организацию, менять их данные в профиле и при необходимости блокировать вход в систему.

GET /members

Получение списка всех участников организации того пользователя, от чьего имени осуществляется запрос. Метод возвращает список всех пользователей организации.

GET https://api.pyrus.com/v4/members

Тело ответа

{
"members":
  [
   {
	"id": 123456,
	"first_name": "Иван",
	"last_name": "Иванов",
	"email": "ivan.ivanov@company.com",
	"type": "user",
	"banned": false,
	"position": "developer",
	"skype": "ivan.ivanov",
	"phone": "+71234567890"
   },
   /*...*/
 ]
}

curl

curl -X GET \
'https://api.pyrus.com/v4/members/' \
-H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
-H 'Content-Type: application/json'

GET /members/{id}

Получение информации о сотруднике по ID. Метод возвращает пользователя с данными его профиля.

GET https://api.pyrus.com/v4/members/{id}

Тело ответа

{
    "id": 664768,
    "first_name": "mna",
    "last_name": "nas",
    "email": "test.pyrus.accaunt@gmail.com",
    "type": "user",
    "external_id": "",
    "banned": true,
    "fired": true,
    "position": "",
    "skype": "",
    "phone": "",
    "rights": 0,
    "login_phone": "",
    "web_session_settings": {
        "life_span_hours": 8760
    },
    "mobile_session_settings": {},
    "web_session_inactive_settings": {},
    "mobile_session_inactive_settings": {}
}

curl

curl -X GET \
    'https://api.pyrus.com/v4/members/<MEMBER_ID>' \
    -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
    -H 'Content-Type: application/json'

POST /members

Добавление пользователя. Метод возвращает пользователя-участника организации.

POST https://api.pyrus.com/v4/members

Тело запроса

{
	"first_name": "Иван",
	"last_name": "Иванов",
	"email": "ivan.ivanov@company.com",
	"position": "developer",
	"department_id": 123,
	"skype": "ivan.ivanov",
	"phone": "+71234567890"
   }

Тело ответа

"id": 123456,
   "first_name": "Иван",
   "last_name": "Иванов",
   "email": "ivan.ivanov@company.com",
   "type": "user",
   "banned": false,
   "position": "developer",
   "skype": "ivan.ivanov",
   "phone": "+71234567890"
}

curl

curl -X POST \
 'https://api.pyrus.com/v4/members/' \
 -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
 -H 'Content-Type: application/json' \
 -d '{
	"first_name": "Иван",
	"last_name": "Иванов",
	"email": "ivan.ivanov@company.com",
	"position": "developer",
	"department_id": 123,
	"skype": "ivan.ivanov",
	"phone_number": "+71234567890"
   } '

Важно: во избежание злоупотреблений на использование метода POST/members наложены ограничения в дополнение к общим ограничениям на число вызовов API. При корректном использовании даже самые крупные организации не превысят разрешенных лимитов.

PUT /members/{id}

Изменение данных пользователя по ID. Метод возвращает пользователя с измененными данными профиля

PUT: https://api.pyrus.com/v4/members/{id}

Тело запроса

{
	"first_name": "Иван",
	"last_name": "Иванов",
	"email": "ivan.ivanov@company.com",
	"position": "developer",
	"department_id": 123,
	"skype": "ivan.ivanov",
	"phone": "+71234567890",
	"banned": false
   }

Тело ответа

{
   "id": 123456,
   "first_name": "Иван",
   "last_name": "Иванов",
   "email": "ivan.ivanov@company.com",
   "type": "user",
   "banned": false,
   "position": "developer",
   "skype": "ivan.ivanov",
   "phone": "+71234567890"
}

curl

curl -X PUT \
 'https://api.pyrus.com/v4/members/<MEMBER_ID>' \
 -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
 -H 'Content-Type: application/json' \
 -d '{
	"first_name": "Иван",
	"last_name": "Иванов",
	"email": "ivan.ivanov@company.com",
	"position": "developer",
	"department_id": 123,
	"skype": "ivan.ivanov",
	"phone": +71234567890",
	"banned": false
   }'

Подсказка: параметры, которые вы не хотите менять, в запросе можно не указывать — в этом случае они сохранят свои предыдущие значения.

DELETE /members/{id}

Блокировка пользователя по ID. Метод возвращает пользователя, для которого запрещен доступ в Pyrus.

DELETE: https://api.pyrus.com/v4/members/{id}

Тело ответа

{
	"id": 123456,
	"first_name": "Иван",
	"last_name": "Иванов",
	"email": "ivan.ivanov@company.com",
	"type": "user",
	"banned": true,
	"position": "developer",
	"skype": "ivan.ivanov",
	"phone": "+71234567890"
}

curl

curl -X DELETE \
 'https://api.pyrus.com/v4/members/<MEMBER_ID>' \
 -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
 -H 'Content-Type: application/json'

Была ли эта статья полезной?