Teams
Team objects are used to group users into teams.
Attribute | Type | Description |
id | string | Unique team identifier |
name | string | Team name |
created_at | string | Time when the team was created. RFC 3339 format. |
Example:
{"id": "16682617-f25d-4df2-9f51-3c38298996b8","name": "Product Engineering","created_at": "2018-02-20T12:32:56Z"}
postCreate Team
post
https://api.simpleokr.com/v1/teams
Create a new Team object.
Request
Response
Request
Body Parameters
name
required
string
Name of the team
Response
200: OK
On success, a new Team object is returned.
{"id": "16682617-f25d-4df2-9f51-3c38298996b8","name": "Product Engineering","created_at": "2018-02-20T12:32:56Z"}
getList Teams
get
https://api.simpleokr.com/v1/teams
Returns a list of your teams.
Request
Response
Request
Query Parameters
page_token
optional
string
Page number
Response
200: OK
{"next_page_token": null,"teams": [{"id": "16682617-f25d-4df2-9f51-3c38298996b8","name": "Product Engineering","created_at": "2018-02-20T12:32:56Z"},{...},{...}]}
getRetrieve Team
get
https://api.simpleokr.com/v1/teams/:id
Retrieve details about the existing Team. Supply the unique Team ID from either a team creation response or team list response.
Request
Response
Request
Path Parameters
id
required
string
Team ID
Response
200: OK
{"id": "16682617-f25d-4df2-9f51-3c38298996b8","name": "Product Engineering","created_at": "2018-02-20T12:32:56Z"}
postUpdate Team
post
https://api.simpleokr.com/v1/teams/:id
Update details of an existing team
Request
Response
Request
Path Parameters
id
required
string
Team ID
Body Parameters
name
required
string
New team name
Response
200: OK
Responds with an updated Team object.
{"id": "16682617-f25d-4df2-9f51-3c38298996b8","name": "Product Engineering","created_at": "2018-02-20T12:32:56Z"}
deleteDelete Team
delete
https://api.simpleokr.com/v1/teams/:id
Delete an existing Team.
Request
Response
Request
Response
200: OK
Last updated 2 years ago