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

get
Project Member List

{{ base_url }} /projects/member/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
Query Parameters
project__sid
required
string
Response
200: OK
# 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
},
]
}

post
Project Member List

{{ base_url }} /projects/member/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
Query Parameters
project__sid
required
string
Form Data Parameters
member
optional
array
team
optional
array
permission
required
string
is_archived
optional
string
Response
201: Created
{
"sid": "xxx",
"name": "xxx",
"team": null,
"personnel": {
"sid": "xxx",
"name": "xxx"
},
"project": {
"sid": "xxx",
"name": "xxx"
},
"permission": "Admin",
"is_archived": false,
"change_permission": true
}

get
Project Member Detail

{{ base_url }} /projects/projectmember/detail/{sid}/
Request
Response
Request
Path Parameters
sid
required
string
Headers
token
required
string
Response
200: OK
{
"sid": "xxx",
"name": "xxx",
"team": null,
"personnel": {
"sid": "xxx",
"name": "xxx"
},
"project": {
"sid": "xxx",
"name": "xxx"
},
"permission": "Admin",
"is_archived": false,
"change_permission": true
}

patch
Project Member Detail

{{ base_url }} /projects/projectmember/detail/{sid}/
Request
Response
Request
Path Parameters
sid
required
string
Headers
token
required
string
Form Data Parameters
team
optional
object
member
optional
object
permission
optional
string
is_archived
optional
boolean
Response
200: OK
{
"sid": "xxx",
"name": "xxx",
"team": null,
"personnel": {
"sid": "xxx",
"name": "xxx"
},
"project": {
"sid": "xxx",
"name": "xxx"
},
"permission": "Admin",
"is_archived": false,
"change_permission": true
}

delete
Project Member Detail

{{ base_url }} /projects/projectmember/detail/{sid}/
Request
Response
Request
Path Parameters
sid
required
string
Headers
token
required
string
Response
204: No Content
{}