Teams

List the teams in your organisation. Team _ids from here are what the x-team-id header expects.

Fetch all the teams

get

Get details of all the teams in your organisation.

Authorizations

x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

Header parameters

x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

Responses

200

Successful response

application/json

401

Unauthorized

application/json

get/teams/get-all-teams

GET /teams/get-all-teams HTTP/1.1
Host: api.spike.sh
x-api-key: text
Accept: */*

{
  "teams": [
    {
      "_id": "5f2b1c4d9e8a7b6c5d4e3f21",
      "name": "Engineering",
      "uid": "eng",
      "private": false,
      "org": "5f72e289b17d1656e0115098"
    },
    {
      "_id": "5f2b1c4d9e8a7b6c5d4e3f22",
      "name": "Platform",
      "uid": "plat",
      "private": false,
      "org": "5f72e289b17d1656e0115098"
    }
  ]
}

Fetch all the teams you are part of

get

Get details of all the teams that you are a member of

Authorizations

x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

Query parameters

idstringRequired

Header parameters

x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

Responses

200

Successful response

application/json

401

Unauthorized

application/json

get/teams/get-my-teams

GET /teams/get-my-teams?id=text HTTP/1.1
Host: api.spike.sh
x-api-key: text
Accept: */*

{
  "teams": [
    {
      "_id": "5f2b1c4d9e8a7b6c5d4e3f21",
      "name": "Engineering",
      "uid": "eng",
      "private": false,
      "org": "5f72e289b17d1656e0115098"
    }
  ]
}