API documentation

Supported Formats

json

>>>

GET /api/v1/teams
List user teams

Supported Formats

json

Examples

GET /api/v1/teams
200
[
  {
    "id": 624,
    "name": "test",
    "is_default": true,
    "created_at": "2016-01-07T02:12:40.000Z",
    "updated_at": "2016-01-07T02:12:44.000Z",
    "html_url": "http://www.example.com/test",
    "avatar_url": "http://www.example.com/test/avatar",
    "role": "manager",
    "managers": [
      {
        "id": 3,
        "username": "test",
        "receive_email": true,
        "created_at": "2016-01-07T02:12:39.000Z",
        "updated_at": "2016-01-07T02:12:47.000Z",
        "keyboard_shortcuts": false,
        "options": {
          "advanced_menu": true
        },
        "html_url": "http://www.example.com/test",
        "avatar_url": "http://www.example.com/test/avatar",
        "lang": {
          "code": "en",
          "model": "lang"
        },
        "name": "test",
        "model": "user"
      }
    ],
    "members": [],
    "plan": "micro",
    "model": "team"
  },
  {
    "id": 628,
    "name": "some",
    "is_default": false,
    "created_at": "2016-01-07T02:12:45.000Z",
    "updated_at": "2016-01-07T02:12:45.000Z",
    "html_url": "http://www.example.com/some",
    "avatar_url": "http://www.example.com/some/avatar",
    "role": "member",
    "managers": [],
    "members": [
      {
        "id": 3,
        "username": "test",
        "receive_email": true,
        "created_at": "2016-01-07T02:12:39.000Z",
        "updated_at": "2016-01-07T02:12:47.000Z",
        "keyboard_shortcuts": false,
        "options": {
          "advanced_menu": true
        },
        "html_url": "http://www.example.com/test",
        "avatar_url": "http://www.example.com/test/avatar",
        "lang": {
          "code": "en",
          "model": "lang"
        },
        "name": "test",
        "model": "user"
      }
    ],
    "plan": "micro",
    "model": "team"
  },
  {
    "id": 630,
    "name": "manager",
    "is_default": false,
    "created_at": "2016-01-07T02:12:46.000Z",
    "updated_at": "2016-01-07T02:12:47.000Z",
    "html_url": "http://www.example.com/manager",
    "avatar_url": "http://www.example.com/manager/avatar",
    "role": "manager",
    "managers": [
      {
        "id": 3,
        "username": "test",
        "receive_email": true,
        "created_at": "2016-01-07T02:12:39.000Z",
        "updated_at": "2016-01-07T02:12:47.000Z",
        "keyboard_shortcuts": false,
        "options": {
          "advanced_menu": true
        },
        "html_url": "http://www.example.com/test",
        "avatar_url": "http://www.example.com/test/avatar",
        "lang": {
          "code": "en",
          "model": "lang"
        },
        "name": "test",
        "model": "user"
      }
    ],
    "members": [],
    "plan": "micro",
    "model": "team"
  },
  {
    "id": 631,
    "name": "member",
    "is_default": false,
    "created_at": "2016-01-07T02:12:47.000Z",
    "updated_at": "2016-01-07T02:12:48.000Z",
    "html_url": "http://www.example.com/member",
    "avatar_url": "http://www.example.com/member/avatar",
    "role": "member",
    "managers": [],
    "members": [
      {
        "id": 3,
        "username": "test",
        "receive_email": true,
        "created_at": "2016-01-07T02:12:39.000Z",
        "updated_at": "2016-01-07T02:12:47.000Z",
        "keyboard_shortcuts": false,
        "options": {
          "advanced_menu": true
        },
        "html_url": "http://www.example.com/test",
        "avatar_url": "http://www.example.com/test/avatar",
        "lang": {
          "code": "en",
          "model": "lang"
        },
        "name": "test",
        "model": "user"
      }
    ],
    "plan": "micro",
    "model": "team"
  }
]

>>>

GET /api/v1/teams/:name
Get a single team

Supported Formats

json

Examples

GET /api/v1/teams/test
200
{
  "id": 563,
  "name": "test",
  "is_default": true,
  "created_at": "2016-01-07T02:11:45.000Z",
  "updated_at": "2016-01-07T02:11:50.000Z",
  "html_url": "http://www.example.com/test",
  "avatar_url": "http://www.example.com/test/avatar",
  "role": "manager",
  "managers": [
    {
      "id": 3,
      "username": "test",
      "receive_email": true,
      "created_at": "2016-01-07T02:11:45.000Z",
      "updated_at": "2016-01-07T02:11:53.000Z",
      "keyboard_shortcuts": false,
      "options": {
        "advanced_menu": true
      },
      "html_url": "http://www.example.com/test",
      "avatar_url": "http://www.example.com/test/avatar",
      "lang": {
        "code": "en",
        "model": "lang"
      },
      "name": "test",
      "model": "user"
    }
  ],
  "members": [],
  "plan": "micro",
  "model": "team"
}

>>>

GET /api/v1/teams/:name/notes
List team notes

Supported Formats

json

Examples

GET /api/v1/teams/test/notes
200
[
  {
    "id": 667,
    "is_private": false,
    "slug": "test_note",
    "title": "Test note",
    "created_at": "2016-01-07T02:12:17.000Z",
    "updated_at": "2016-01-07T02:12:18.000Z",
    "format": "html",
    "share": "none",
    "is_time_track": true,
    "name": "test_note",
    "team": {
      "id": 593,
      "name": "test",
      "is_default": true,
      "created_at": "2016-01-07T02:12:13.000Z",
      "updated_at": "2016-01-07T02:12:18.000Z",
      "html_url": "http://www.example.com/test",
      "avatar_url": "http://www.example.com/test/avatar",
      "role": "manager",
      "managers": [
        {
          "id": 3,
          "username": "test",
          "receive_email": true,
          "created_at": "2016-01-07T02:12:13.000Z",
          "updated_at": "2016-01-07T02:12:21.000Z",
          "keyboard_shortcuts": false,
          "options": {
            "advanced_menu": true
          },
          "html_url": "http://www.example.com/test",
          "avatar_url": "http://www.example.com/test/avatar",
          "lang": {
            "code": "en",
            "model": "lang"
          },
          "name": "test",
          "model": "user"
        }
      ],
      "members": [],
      "plan": "micro",
      "model": "team"
    },
    "html_url": "http://www.example.com/test/test_note",
    "avatar_url": "http://www.example.com/test/test_note/avatar",
    "can_pull": false,
    "can_request": false,
    "can_manage": true,
    "description_html": "<p></p>",
    "model": "note"
  }
]

>>>

POST /api/v1/teams
Create

Supported Formats

json

Examples

POST /api/v1/teams
team%5Bname%5D=test_team
200
{
  "id": 621,
  "name": "test_team",
  "is_default": false,
  "created_at": "2016-01-07T02:12:39.905Z",
  "updated_at": "2016-01-07T02:12:39.905Z",
  "html_url": "http://www.example.com/test_team",
  "avatar_url": "http://www.example.com/test_team/avatar",
  "role": "manager",
  "managers": [
    {
      "id": 3,
      "username": "test",
      "receive_email": true,
      "created_at": "2016-01-07T02:12:31.000Z",
      "updated_at": "2016-01-07T02:12:39.000Z",
      "keyboard_shortcuts": false,
      "options": {
        "advanced_menu": true
      },
      "html_url": "http://www.example.com/test",
      "avatar_url": "http://www.example.com/test/avatar",
      "lang": {
        "code": "en",
        "model": "lang"
      },
      "name": "test",
      "model": "user"
    }
  ],
  "members": [],
  "plan": "free",
  "model": "team"
}

Params

Param name	Description
team optional	Value: Must be a Hash
team[name] required	Value: Must be String

>>>

PATCH /api/v1/teams/:name
Update

Supported Formats

json

Examples

PUT /api/v1/teams/manager
team%5Bname%5D=edit_team
200
{
  "id": 589,
  "name": "edit_team",
  "is_default": false,
  "created_at": "2016-01-07T02:12:11.000Z",
  "updated_at": "2016-01-07T02:12:12.856Z",
  "html_url": "http://www.example.com/edit_team",
  "avatar_url": "http://www.example.com/edit_team/avatar",
  "role": "manager",
  "managers": [
    {
      "id": 3,
      "username": "test",
      "receive_email": true,
      "created_at": "2016-01-07T02:12:03.000Z",
      "updated_at": "2016-01-07T02:12:11.000Z",
      "keyboard_shortcuts": false,
      "options": {
        "advanced_menu": true
      },
      "html_url": "http://www.example.com/test",
      "avatar_url": "http://www.example.com/test/avatar",
      "lang": {
        "code": "en",
        "model": "lang"
      },
      "name": "test",
      "model": "user"
    }
  ],
  "members": [],
  "plan": "micro",
  "model": "team"
}

Params

Param name	Description
team optional	Value: Must be a Hash
team[name] required	Value: Must be String

>>>

DELETE /api/v1/teams/:name
Destroy

Supported Formats

json

Examples

DELETE /api/v1/teams/manager
204

>>>

POST /api/v1/teams/:team/users
Add user

Supported Formats

json

Examples

POST /api/v1/teams/manager/users
role=member&username=test1
200
{
  "id": 559,
  "name": "manager",
  "is_default": false,
  "created_at": "2016-01-07T02:11:43.000Z",
  "updated_at": "2016-01-07T02:11:44.000Z",
  "html_url": "http://www.example.com/manager",
  "avatar_url": "http://www.example.com/manager/avatar",
  "role": "manager",
  "managers": [
    {
      "id": 3,
      "username": "test",
      "receive_email": true,
      "created_at": "2016-01-07T02:11:36.000Z",
      "updated_at": "2016-01-07T02:11:44.000Z",
      "keyboard_shortcuts": false,
      "options": {
        "advanced_menu": true
      },
      "html_url": "http://www.example.com/test",
      "avatar_url": "http://www.example.com/test/avatar",
      "lang": {
        "code": "en",
        "model": "lang"
      },
      "name": "test",
      "model": "user"
    }
  ],
  "members": [
    {
      "id": 1,
      "username": "test1",
      "receive_email": true,
      "created_at": "2016-01-07T02:11:36.000Z",
      "updated_at": "2016-01-07T02:11:45.000Z",
      "keyboard_shortcuts": false,
      "html_url": "http://www.example.com/test1",
      "avatar_url": "http://www.example.com/test1/avatar",
      "lang": {
        "code": "ja",
        "model": "lang"
      },
      "name": "test1",
      "model": "user"
    }
  ],
  "plan": "micro",
  "model": "team"
}

POST /api/v1/teams/manager/users
role=member&username=test1
200
{
  "id": 609,
  "name": "manager",
  "is_default": false,
  "created_at": "2016-01-07T02:12:29.000Z",
  "updated_at": "2016-01-07T02:12:29.000Z",
  "html_url": "http://www.example.com/manager",
  "avatar_url": "http://www.example.com/manager/avatar",
  "role": "manager",
  "managers": [
    {
      "id": 3,
      "username": "test",
      "receive_email": true,
      "created_at": "2016-01-07T02:12:22.000Z",
      "updated_at": "2016-01-07T02:12:30.000Z",
      "keyboard_shortcuts": false,
      "options": {
        "advanced_menu": true
      },
      "html_url": "http://www.example.com/test",
      "avatar_url": "http://www.example.com/test/avatar",
      "lang": {
        "code": "en",
        "model": "lang"
      },
      "name": "test",
      "model": "user"
    }
  ],
  "members": [
    {
      "id": 1,
      "username": "test1",
      "receive_email": true,
      "created_at": "2016-01-07T02:12:22.000Z",
      "updated_at": "2016-01-07T02:12:31.000Z",
      "keyboard_shortcuts": false,
      "html_url": "http://www.example.com/test1",
      "avatar_url": "http://www.example.com/test1/avatar",
      "lang": {
        "code": "ja",
        "model": "lang"
      },
      "name": "test1",
      "model": "user"
    }
  ],
  "plan": "micro",
  "model": "team"
}

Params

Param name Description

Param name	Description
username required	Value: Must be String
role optional	Can be either `memeber` or `manager`. Default: `member` Value: Must be String

username
required

Value:

Must be String

role
optional

Can be either memeber or manager. Default: member

Value:

Must be String

>>>

DELETE /api/v1/teams/:team/users/:id
Delete user

Supported Formats

json

Examples

DELETE /api/v1/teams/manager/users/1
200
{
  "id": 609,
  "name": "manager",
  "is_default": false,
  "created_at": "2016-01-07T02:12:29.000Z",
  "updated_at": "2016-01-07T02:12:31.000Z",
  "html_url": "http://www.example.com/manager",
  "avatar_url": "http://www.example.com/manager/avatar",
  "role": "manager",
  "managers": [
    {
      "id": 3,
      "username": "test",
      "receive_email": true,
      "created_at": "2016-01-07T02:12:22.000Z",
      "updated_at": "2016-01-07T02:12:30.000Z",
      "keyboard_shortcuts": false,
      "options": {
        "advanced_menu": true
      },
      "html_url": "http://www.example.com/test",
      "avatar_url": "http://www.example.com/test/avatar",
      "lang": {
        "code": "en",
        "model": "lang"
      },
      "name": "test",
      "model": "user"
    }
  ],
  "members": [],
  "plan": "micro",
  "model": "team"
}

Teams

Supported Formats

GET /api/v1/teams List user teams

Supported Formats

Examples

GET /api/v1/teams/:name Get a single team

Supported Formats

Examples

GET /api/v1/teams/:name/notes List team notes

Supported Formats

Examples

POST /api/v1/teams Create

Supported Formats

Examples

Params

PATCH /api/v1/teams/:name Update

Supported Formats

Examples

Params

DELETE /api/v1/teams/:name Destroy

Supported Formats

Examples

POST /api/v1/teams/:team/users Add user

Supported Formats

Examples

Params

DELETE /api/v1/teams/:team/users/:id Delete user

Supported Formats

Examples

GET /api/v1/teams
List user teams

GET /api/v1/teams/:name
Get a single team

GET /api/v1/teams/:name/notes
List team notes

POST /api/v1/teams
Create

PATCH /api/v1/teams/:name
Update

DELETE /api/v1/teams/:name
Destroy

POST /api/v1/teams/:team/users
Add user

DELETE /api/v1/teams/:team/users/:id
Delete user