Teams API

The Team API is focused on managing teams within a division. It offers endpoints to handle the creation, retrieval, updating, and deletion of team records.

get

Retrieve a list of teams or a specific team by ID.

Authorizations

Query parameters

team_idstringOptional

Optional ID of the team to retrieve.

include_peoplestring · enumOptional

Optional boolean to populate the people in the team.

Default: falsePossible values:

skipintegerOptional

Number of items to skip.

Default: 0

limitintegerOptional

Maximum number of items to return.

Default: 25

sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Default: ascPossible values:

Responses

200

OK

application/json

400

Bad Request

application/json

get

HTTPcURLJavaScriptPython

GET /teams/v1/teams HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "teams": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 20
    }
  },
  "identifier": "get_teams_successful"
}