Team

API for Team object

Method & Permission

API

GET

POST

PUT

PATCH

DELETE

Team List

Admin

Admin

-

-

-

Team Detail

Admin

-

-

Admin

Admin

Team List

GET {{ base_url }} /organizations/team/list/{level}/{sid}/{serializer}/

Path Parameters

Name
Type
Description

level

string

organization

sid

string

organization sid

serializer

string

Headers

Name
Type
Description

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",
            "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
        }
    ]
}

Team List

POST {{ base_url }} /organizations/team/list/{level}/{sid}/{serializer}/

Path Parameters

Name
Type
Description

level

string

organization

sid

string

organization sid

serializer

string

Headers

Name
Type
Description

token

string

Request Body

Name
Type
Description

name

string

description

string

is_archived

string

members

array

array of organization personnel sid

{
    "sid": "xxx",
    "name": "xxx",
    "description": "Admin group to manage the Labii account.",
    "members": [
        {
            "sid": "xxx",
            "name": "xxx"
        },
    ],
    "is_archived": false,
    "change_permission": true
}

Team Detail

GET {{ base_url }} /organizations/team/detail/{sid}/

Path Parameters

Name
Type
Description

sid

string

Headers

Name
Type
Description

token

string

{
    "sid": "xxx",
    "name": "xxx",
    "description": "Admin group to manage the Labii account.",
    "members": [
        {
            "sid": "xxx",
            "name": "xxx"
        },
    ],
    "is_archived": false,
    "change_permission": true
}

Team Detail

PATCH {{ base_url }} /organizations/team/detail/{sid}/

Path Parameters

Name
Type
Description

sid

string

Headers

Name
Type
Description

token

string

Request Body

Name
Type
Description

name

string

description

string

members

array

is_archived

boolean

{
    "sid": "xxx",
    "name": "xxx",
    "description": "Admin group to manage the Labii account.",
    "members": [
        {
            "sid": "xxx",
            "name": "xxx"
        },
    ],
    "is_archived": false,
    "change_permission": true
}

Team Detail

DELETE {{ base_url }} /organizations/team/detail/{sid}/

Path Parameters

Name
Type
Description

sid

string

Headers

Name
Type
Description

token

string

{}

Last updated