GET/teams/{id}.json

Returns a single team identified by it's ID

A Team identified by the ID and is visible to the user will be returned.


Path Params

  • Name
    id
    Type
    string
    required
    Description

Query Params

  • Name
    includeSubteams
    Type
    boolean
    Description

    Use this to include any subteams matching the filters.

    Default
    false
  • Name
    include
    Type
    string
    Description

    Options for include:

    • members. This will include information about the team members
    Allowed values
    • members
  • Name
    showDeleted
    Type
    boolean
    Description
    Default
    false
  • Name
    getEmoji
    Type
    boolean
    Description
    Default
    true

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 Response
  • Code
    404
    Type
    object
    Schema
    Description
    404 Response

Examples

Example

{
  "STATUS": "string",
  "team": {
    "createdByUserId": "string",
    "name": "string",
    "description": "string",
    "logoIcon": "string",
    "deletedDate": "string",
    "handle": "string",
    "dateUpdated": "string",
    "company": {
      "name": "string",
      "id": "string"
    },
    "parentTeam": {
      "name": "string",
      "handle": "string",
      "id": "string"
    },
    "rootTeam": {
      "name": "string",
      "handle": "string",
      "id": "string"
    },
    "numMembers": "string",
    "projectId": "string",
    "logoUrl": "string",
    "members": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "logoColor": "string",
    "numDirectChildren": "string",
    "canEdit": true,
    "updatedByUserId": "string",
    "isPrivate": true,
    "id": "string",
    "dateCreated": "string",
    "defaultProjectIds": "string",
    "numSubteams": "string",
    "deleted": true
  },
  "users": {},
  "projects": {}
}