Skip to main content
GET
/
poolside
/
v1
/
teams
List teams
curl --request GET \
  --url https://api.example.com/poolside/v1/teams \
  --header 'Authorization: Bearer <token>'
{
  "links": {
    "next": "<string>"
  },
  "teams": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ],
  "$schema": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
start_token
string

token for fetching the next page of results, if any. May specify start_token or page but not both.

Minimum string length: 4
​
page_size
integer<int64>

Items per page (defaults to 20, max 300)

​
name
string

filter teams by name, using exact match

​
name_prefix
string

filter teams by name, using prefix match

Response

OK

​
links
object
required
​
teams
object[]
required

a page of teams

​
$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/ListTeamsPage.json"