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
should_receive_weekly_digest
should_receive_statement_digest
should_receive_mention_notification
should_receive_record_change_notification
should_receive_notification_email
Organization Personnel List
GET
/organizations/personnel/list/{level}/{sid}/{serializer}/
Return the members of the organization.
Path Parameters
level
string
organization
sid
string
organization sid
serializer
string
Headers
token
string
# 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": "[email protected]",
"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": "[email protected]",
"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"
}
]
}
Organization Personnel List
POST
/organizations/personnel/list/{level}/{sid}/{serializer}/
Create one or more members to the organization
Path Parameters
level
string
organization
sid
string
organization sid
serializer
string
Headers
token
string
Request Body
string
first_name
string
last_name
string
title
string
date_start
string
date_end
string
is_administrator
string
is_archived
string
{
"sid": "xxx",
"name": "xxx",
"email": "[email protected]",
"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"
}
Organization Personnel Detail
GET
/organizations/personnel/detail/{sid}/
Get the detail of a member.
Path Parameters
sid
string
{
"sid": "xxx",
"name": "xxx",
"email": "[email protected]",
"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"
}
Organization Personnel Detail
PATCH
/organizations/personnel/detail/{sid}/
Update the data for a member
Path Parameters
sid
string
Request Body
title
string
date_start
string
date_end
string
is_administrator
string
is_archived
string
{
"sid": "xxx",
"name": "xxx",
"email": "[email protected]",
"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"
}
Last updated