Team

API for Team object

Method & Permission

API

GET

POST

PUT

PATCH

DELETE

Team List

Admin

Admin

-

-

-

Team Detail

Admin

-

-

Admin

Admin

get
Team List

{{ base_url }} /organizations/team/list/{level}/{sid}/{serializer}/
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",
"description": "Admin group to manage the Labii account.",
"is_archived": false,
"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",
"description": "Admin group to manage the Labii account.",
"members": [
{
"sid": "xxx",
"name": "xxx"
},
],
"is_archived": false,
"change_permission": true
}
]
}

post
Team List

{{ base_url }} /organizations/team/list/{level}/{sid}/{serializer}/
Request
Response
Request
Path Parameters
level
required
string
organization
sid
required
string
organization sid
serializer
required
string
​
Headers
token
required
string
​
Form Data Parameters
name
required
string
​
description
optional
string
​
is_archived
optional
string
​
members
optional
array
array of organization personnel sid
Response
201: Created
{
"sid": "xxx",
"name": "xxx",
"description": "Admin group to manage the Labii account.",
"members": [
{
"sid": "xxx",
"name": "xxx"
},
],
"is_archived": false,
"change_permission": true
}

get
Team Detail

{{ base_url }} /organizations/team/detail/{sid}/
Request
Response
Request
Path Parameters
sid
required
string
​
Headers
token
required
string
​
Response
200: OK
{
"sid": "xxx",
"name": "xxx",
"description": "Admin group to manage the Labii account.",
"members": [
{
"sid": "xxx",
"name": "xxx"
},
],
"is_archived": false,
"change_permission": true
}

patch
Team Detail

{{ base_url }} /organizations/team/detail/{sid}/
Request
Response
Request
Path Parameters
sid
required
string
​
Headers
token
required
string
​
Form Data Parameters
name
optional
string
​
description
optional
string
​
members
optional
array
​
is_archived
optional
boolean
​
Response
200: OK
{
"sid": "xxx",
"name": "xxx",
"description": "Admin group to manage the Labii account.",
"members": [
{
"sid": "xxx",
"name": "xxx"
},
],
"is_archived": false,
"change_permission": true
}

delete
Team Detail

{{ base_url }} /organizations/team/detail/{sid}/
Request
Response
Request
Path Parameters
sid
required
string
​
Headers
token
required
string
​
Response
204: No Content
{}