Teams - Huddle/huddle-apis GitHub Wiki

Summary

Note: This document uses the /people API prefix. A newer /membership equivalent is also available — see TeamsNew.

People API: List teams for a workspace with GET /people/workspaces/{workspaceId}/teams.

Operations

Method Path Purpose Details
GET /people/workspaces/{workspaceId}/teams Retrieve teams for a workspace Jump

On Membership, listing teams often supports query parameters such as name, pagesize, skip, and hasUser — see WorkspaceNew.


Retrieve the teams of a given workspace

People: Company managers or workspace managers see all teams in the workspace; other users must belong to at least one team in the workspace or they receive 403 Forbidden. The workspace must exist and the user must be in the workspace’s company.

XML example

Request

GET /people/workspaces/123/teams HTTP/1.1
Accept: application/vnd.huddle.data+xml
Authorization: Bearer frootymcnooty/vonbootycherooty

Response

HTTP/1.1 200 OK
Content-Type: application/vnd.huddle.data+xml
<teams>
  <link rel="self" href="people/workspaces/123/teams" />
  <team>
    <link rel="self" href="..." />
    <name>Team Keen</name>
  </team>
  <team>
    <link rel="self" href="..." />
    <name>Dev Leppard</name>
  </team>
</teams>

JSON example

Request

GET /people/workspaces/123/teams HTTP/1.1
Accept: application/vnd.huddle.data+json
Authorization: Bearer frootymcnooty/vonbootycherooty

Response

HTTP/1.1 200 OK
Content-Type: application/vnd.huddle.data+json
{
  "links": [{ "rel": "self", "href": "..." }],
  "teams": [
    {
      "links": [{ "rel": "self", "href": "..." }],
      "name": "Team Keen"
    },
    {
      "links": [{ "rel": "self", "href": "..." }],
      "name": "Dev Leppard"
    }
  ]
}

Link relations

Name Description Methods
self This teams list resource. GET

Other responses

Case Response
Invalid authorization 401 Unauthorized
User in company but not in workspace (unless workspace/company manager) 403 Forbidden
Workspace missing / user not in company 404 Not Found

Related

⚠️ **GitHub.com Fallback** ⚠️