Teams

Team objects are used to group users into teams.

The Team object

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"
}

Create Team

POST https://api.simpleokr.com/v1/teams

Create a new Team object.

Request Body

Name	Type	Description
name	string	Name of the team

200 On success, a new Team object is returned.

{
  "id": "16682617-f25d-4df2-9f51-3c38298996b8",
  "name": "Product Engineering",
  "created_at": "2018-02-20T12:32:56Z"
}

List Teams

GET https://api.simpleokr.com/v1/teams

Returns a list of your teams.

Query Parameters

Name	Type	Description
page_token	string	Page number

200

{
  "next_page_token": null,
  "teams": [
    {
      "id": "16682617-f25d-4df2-9f51-3c38298996b8",
      "name": "Product Engineering",
      "created_at": "2018-02-20T12:32:56Z"
    },
    {...},
    {...}
  ]
}

Retrieve 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.

Path Parameters

Name	Type	Description
id	string	Team ID

200

{
  "id": "16682617-f25d-4df2-9f51-3c38298996b8",
  "name": "Product Engineering",
  "created_at": "2018-02-20T12:32:56Z"
}

Update Team

POST https://api.simpleokr.com/v1/teams/:id

Update details of an existing team

Path Parameters

Name	Type	Description
id	string	Team ID

Request Body

Name	Type	Description
name	string	New team name

200 Responds with an updated Team object.

{
  "id": "16682617-f25d-4df2-9f51-3c38298996b8",
  "name": "Product Engineering",
  "created_at": "2018-02-20T12:32:56Z"
}

Delete Team

DELETE https://api.simpleokr.com/v1/teams/:id

Delete an existing Team.

200