Retrieve a team

There are a couple of different ways to get team information.

Endpoints

Get all teams in an organization

  • GET /teams
    • Permissions: team:read
    • Roles: owner

Response: Paginated Array

  • id - string: Team Id
  • name - string: Team name
  • total_users - number: Sum of all users currently in team

Example

$ http GET 'http://localhost:5000/teams?limit=2' 'X-Tactic-Orgz: ORGANIZATION_SLUG' 'Authorization: Bearer ACCESS_TOKEN'
HTTP/1.1 200 OK
{
"cursor": "team_eb2d3761-21ec-433b-bd23-944cd9c22a98",
"elements": [
{
"id": "team_481f5742-9620-49df-82aa-ce23d64e5575",
"name": "Test Org - Team 1",
"total_users": 1
},
{
"id": "team_eb2d3761-21ec-433b-bd23-944cd9c22a98",
"name": "Test Org - Team 2",
"total_users": 3
}
]
}

Get information about a specific team

  • GET /teams/:id
    • Permissions: team:read
    • Roles: owner

Response: Paginated Array

  • id - string: Team Id
  • name - string: Team name
  • total_users - number: Sum of all users currently in team

Example

$ http GET 'http://localhost:5000/teams/team_eb2d3761-21ec-433b-bd23-944cd9c22a98' 'X-Tactic-Orgz: ORGANIZATION_SLUG' 'Authorization: Bearer ACCESS_TOKEN'
HTTP/1.1 200 OK
{
"id": "team_eb2d3761-21ec-433b-bd23-944cd9c22a98",
"name": "Test Org - Team 2",
"total_users": 3
}
Was this page helpful?