Personnel

API for Organization Member object

Method & Permission

API

GET

POST

PUT

PATCH

DELETE

Personnel List

Admin, Member

Admin

-

-

-

Personnel Detail

Admin, Member

-

-

Admin, Member**

-

**Member can only update the following fields:

  • first_name

  • last_name

  • email

  • metadata

  • dashboard

get
Organization Personnel List

/organizations/personnel/list/{level}/{sid}/{serializer}/
Return the members of the organization.
Request
Response
Request
Path Parameters
level
required
string
organization
sid
required
string
organization sid
serializer
required
string
Headers
token
required
string
Response
200: OK
# serializer = name
{
"page_size": 10,
"page_number": 1,
"page_count": 1,
"count": 1,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"name": "xxx"
}
]
}
# serializer = list
{
"page_size": 10,
"page_number": 1,
"page_count": 1,
"count": 1,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"name": "xxx",
"email": "xxx@labii.com",
"title": "Administrator",
"is_administrator": true,
"is_archived": false,
"date_start": "2020-05-31",
"date_end": null,
"change_permission": true
}
]
}
# serializer = detail
{
"page_size": 10,
"page_number": 1,
"page_count": 1,
"count": 1,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"name": "xxx",
"email": "xxx@labii.com",
"first_name": "xxx",
"last_name": "xxx",
"title": "Administrator",
"date_start": "2020-05-31",
"date_end": null,
"is_administrator": true,
"dashboard": [
{
"link": "https://docs.labii.com/quick-start",
"note": "1. Quick start guide"
},
...
],
"is_use_single_sign_on": true,
"should_receive_weekly_digest": true,
"should_receive_mention_notification": true,
"should_receive_record_change_notification": true,
"metadata": [
],
"is_archived": false,
"change_permission": true,
"updated_by": "xxx",
"date_updated": "2020-05-31T07:00:46.705116Z"
}
]
}

post
Organization Personnel List

/organizations/personnel/list/{level}/{sid}/{serializer}/
Create one or more members to the organization
Request
Response
Request
Path Parameters
level
required
string
organization
sid
required
string
organization sid
serializer
required
string
Headers
token
required
string
Form Data Parameters
email
required
string
first_name
required
string
last_name
required
string
title
required
string
date_start
optional
string
date_end
optional
string
is_administrator
optional
string
is_archived
optional
string
Response
201: Created
{
"sid": "xxx",
"name": "xxx",
"email": "xxx@labii.com",
"first_name": "xxx",
"last_name": "xxx",
"title": "Administrator",
"date_start": "2020-05-31",
"date_end": null,
"is_administrator": true,
"dashboard": [
{
"link": "https://docs.labii.com/quick-start",
"note": "1. Quick start guide"
},
...
],
"is_use_single_sign_on": true,
"should_receive_weekly_digest": true,
"should_receive_mention_notification": true,
"should_receive_record_change_notification": true,
"metadata": [
],
"is_archived": false,
"change_permission": true,
"updated_by": "xxx",
"date_updated": "2020-05-31T07:00:46.705116Z"
}
406: Not Acceptable
- The fields organization, user must make a unique set.
- Your organization does not have enough seats to add new members. Contact sales@labii.com to increase seats.
- Wrong email: xxx. Emails from academic or non-profile companies only.

get
Organization Personnel Detail

/organizations/personnel/detail/{sid}/
Get the detail of a member.
Request
Response
Request
Path Parameters
sid
required
string
Response
200: OK
{
"sid": "xxx",
"name": "xxx",
"email": "xxx@labii.com",
"first_name": "xxx",
"last_name": "xxx",
"title": "Administrator",
"date_start": "2020-05-31",
"date_end": null,
"is_administrator": true,
"dashboard": [
{
"link": "https://docs.labii.com/quick-start",
"note": "1. Quick start guide"
},
...
],
"is_use_single_sign_on": true,
"should_receive_weekly_digest": true,
"should_receive_mention_notification": true,
"should_receive_record_change_notification": true,
"metadata": [
],
"is_archived": false,
"change_permission": true,
"updated_by": "xxx",
"date_updated": "2020-05-31T07:00:46.705116Z"
}

patch
Organization Personnel Detail

/organizations/personnel/detail/{sid}/
Update the data for a member
Request
Response
Request
Path Parameters
sid
required
string
Form Data Parameters
title
optional
string
date_start
optional
string
date_end
optional
string
is_administrator
optional
string
is_archived
optional
string
Response
200: OK
{
"sid": "xxx",
"name": "xxx",
"email": "xxx@labii.com",
"first_name": "xxx",
"last_name": "xxx",
"title": "Administrator",
"date_start": "2020-05-31",
"date_end": null,
"is_administrator": true,
"dashboard": [
{
"link": "https://docs.labii.com/quick-start",
"note": "1. Quick start guide"
},
...
],
"is_use_single_sign_on": true,
"should_receive_weekly_digest": true,
"should_receive_mention_notification": true,
"should_receive_record_change_notification": true,
"metadata": [
],
"is_archived": false,
"change_permission": true,
"updated_by": "xxx",
"date_updated": "2020-05-31T07:00:46.705116Z"
}