Team

Last updated 7 months ago
API for Team object
get
Team List
{{ base_url }}
 /organizations/team/list/{level}/{sid}/{serializer}/
Request
Response
Path Parameters
level
required
string
user, organization
sid
required
string
​
serializer
required
string
​
Headers
token
required
string
​
200: OK
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 1,
    "count": 1,
    "next": null,
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "name": "xxx",
            "description": "xxx",
            "is_archived": false,
            "change_permission": true
        },
        ...
    ]
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - The provided sid is not correct
Wrong level: xxx. Acceptable levels is user, organization. - Wrong level provided
post
Team List
{{ base_url }}
 /organizations/team/list/{level}/{sid}/{serializer}/
Request
Response
Path Parameters
level
required
string
organization
sid
required
string
​
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 member sid
201: Created
{
    "sid": "xxx",
    "name": "xxx",
    "description": "xxx",
    "members": [
        "xxx",
        "xxx"
    ],
    "is_archived": false,
    "change_permission": true
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - The provided sid is not correct
Wrong level: xxx. Acceptable levels is user, organization. - Wrong level provided
get
Team Detail
{{ base_url }}
 /organizations/team/detail/{sid}/
Request
Response
Path Parameters
sid
required
string
​
Headers
token
required
string
​
200: OK
{
    "sid": "xxx",
    "name": "xxx",
    "description": "xxx",
    "members": [
        "xxx",
        "xxx"
    ],
    "is_archived": false,
    "change_permission": true
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - The provided sid is not correct
patch
Team Detail
{{ base_url }}
 /organizations/team/detail/{sid}/
Request
Response
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
​
200: OK
{
    "sid": "xxx",
    "name": "xxx",
    "description": "xxx",
    "members": [
        "xxx",
        "xxx"
    ],
    "is_archived": false,
    "change_permission": true
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - The provided sid is not correct
delete
Team Detail
{{ base_url }}
 /organizations/team/detail/{sid}/
Request
Response
Path Parameters
sid
required
string
​
Headers
token
required
string
​
204: No Content
{}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
Organization Member
Organization Widget
Team

getTeam List

postTeam List

getTeam Detail

patchTeam Detail

deleteTeam Detail

get
Team List

post
Team List

get
Team Detail

patch
Team Detail

delete
Team Detail
