Member

API for Project Member object

Method & Permission

API	GET	POST	PUT	PATCH	DELETE
Member List	Admin, Project Admin, Project Edit, Project View	Admin, Project Admin	-	-	-
Member Detail	Admin, Project Admin, Project Edit, Project View	-	-	Admin, Project Admin	Admin, Project Admin

Project Member List

GET {{ base_url }} /projects/member/list/{level}/{sid}/{serializer}/

Path Parameters

Name	Type	Description
level	string	organization
sid	string	organization sid
serializer	string

Query Parameters

Name	Type	Description
project__sid	string

Headers

Name	Type	Description
token	string

200

# serializer = name
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 1,
    "count": 3,
    "next": null,
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "name": "xxx"
        },
    ]
}
# serializer = list
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 1,
    "count": 3,
    "next": null,
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "team": null,
            "personnel": {
                "sid": "xxx",
                "name": "xxx"
            },
            "project": {
                "sid": "xxx",
                "name": "xxx"
            },
            "permission": "Admin",
            "is_archived": false,
            "change_permission": true
        },
    ]
}
# serializer = detail
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 1,
    "count": 3,
    "next": null,
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "name": "xxx",
            "team": null,
            "personnel": {
                "sid": "xxx",
                "name": "xxx"
            },
            "project": {
                "sid": "xxx",
                "name": "xxx"
            },
            "permission": "Admin",
            "is_archived": false,
            "change_permission": true
        },
    ]
}

Project Member List

POST {{ base_url }} /projects/member/list/{level}/{sid}/{serializer}/

Path Parameters

Name	Type	Description
level	string	organization
sid	string	organization sid
serializer	string

Query Parameters

Name	Type	Description
project__sid	string

Headers

Name	Type	Description
token	string

Request Body

Name	Type	Description
member	array
team	array
permission	string
is_archived	string

201

{
    "sid": "xxx",
    "name": "xxx",
    "team": null,
    "personnel": {
        "sid": "xxx",
        "name": "xxx"
    },
    "project": {
        "sid": "xxx",
        "name": "xxx"
    },
    "permission": "Admin",
    "is_archived": false,
    "change_permission": true
}

Project Member Detail

GET {{ base_url }} /projects/projectmember/detail/{sid}/

Path Parameters

Name	Type	Description
sid	string

Headers

Name	Type	Description
token	string

200

{
    "sid": "xxx",
    "name": "xxx",
    "team": null,
    "personnel": {
        "sid": "xxx",
        "name": "xxx"
    },
    "project": {
        "sid": "xxx",
        "name": "xxx"
    },
    "permission": "Admin",
    "is_archived": false,
    "change_permission": true
}

Project Member Detail

PATCH {{ base_url }} /projects/projectmember/detail/{sid}/

Path Parameters

Name	Type	Description
sid	string

Headers

Name	Type	Description
token	string

Request Body

Name	Type	Description
team	object
member	object
permission	string
is_archived	boolean

200

{
    "sid": "xxx",
    "name": "xxx",
    "team": null,
    "personnel": {
        "sid": "xxx",
        "name": "xxx"
    },
    "project": {
        "sid": "xxx",
        "name": "xxx"
    },
    "permission": "Admin",
    "is_archived": false,
    "change_permission": true
}

Project Member Detail

DELETE {{ base_url }} /projects/projectmember/detail/{sid}/

Path Parameters

Name	Type	Description
sid	string

Headers

Name	Type	Description
token	string

204

{}