List teams
GET https://:subdomain.cobot.me/api/teams
Lists all teams in a space.
- Authentication required
- yes, additionally user must be an admin of the space
- Scope required:
- read_teams
Example
GET https://co-up.cobot.me/api/teams
Response:
[
{
memberships: [
{
membership: {
id: '307401865340875', name: 'Joe Doe'
},
role: 'paying'
},
{
membership: {
id: '124825c425f321a', name: 'Jane Doe'
},
role: 'paid'
}
]
}
]
List team members
GET https://:subdomain.cobot.me/api/team
Returns the members of a team. Teams are created when one member pays for others.
- Authentication required
- yes, additionally user must be member of the space
- Scope required:
- team
Example
GET https://co-up.cobot.me/api/team
Response:
[
{
membership: {
id: '307401865340875', name: 'Joe Doe'
},
role: 'paying'
},
{
membership: {
id: '124825c425f321a', name: 'Jane Doe'
},
role: 'paid'
}
]
Team members can retrieve other team members' check-ins via /api/memberships/:membership_id/check_ins?from=:date&to=:date
and invoices via /api/memberships/:membership_id/invoices
.
Add Team Member
POST https://:subdomain.cobot.me/api/memberships/:paying_membership_id/team/team_members
- Authentication required
- yes, additionally user must be an admin of the space
- Scope required:
- write_team_member
Example
POST https://co-up.cobot.me/api/memberships/307401865340875/team/team_members
Body:
{
"membership_id": 3207948075804
}
Response:
{
"memberships":
[
{
"membership": {:id=>"307401865340875", "name": "paying membership"},
"role": "paying"
},
{
"membership": {"id": "3207948075804", "name": "new membership"},
"role": "paid"
}
]
}
We assume that the membership id in the URL is the paying membership in the team if no other paying membership exists yet.
Response status is 201 on success, 409 if the team member already exists or if the paying membership is already being paid for by another member.
Remove a Team Member
DELETE http://:subdomain.cobot.me/api/memberships/:paying_membership_id/team/team_members/:membership_id
- Authentication required
- yes, additionally user must be an admin of the space
- Scope required:
- write_team_member
Example
DELETE http://co-up.cobot.me/api/memberships/307401865340875/team/team_members/3207948075804
Response:
Status 204, no body