List teams

Return a paginated list of teams in the current account.

POST /team/list

List teams

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/team/list?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "p": 1,
  "limit": 20,
  "orderby": "created_at",
  "asc": false
}
'

import requests

url = "https://api.flashcat.cloud/team/list?app_key="

payload = {
    "p": 1,
    "limit": 20,
    "orderby": "created_at",
    "asc": False
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({p: 1, limit: 20, orderby: 'created_at', asc: false})
};

fetch('https://api.flashcat.cloud/team/list?app_key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flashcat.cloud/team/list?app_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'p' => 1,
    'limit' => 20,
    'orderby' => 'created_at',
    'asc' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.flashcat.cloud/team/list?app_key="

	payload := strings.NewReader("{\n  \"p\": 1,\n  \"limit\": 20,\n  \"orderby\": \"created_at\",\n  \"asc\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/team/list?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"p\": 1,\n  \"limit\": 20,\n  \"orderby\": \"created_at\",\n  \"asc\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/team/list?app_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"p\": 1,\n  \"limit\": 20,\n  \"orderby\": \"created_at\",\n  \"asc\": false\n}"

response = http.request(request)
puts response.read_body

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "p": 1,
    "limit": 20,
    "total": 5,
    "items": [
      {
        "account_id": 10023,
        "team_id": 1001,
        "team_name": "Backend SRE",
        "status": "enabled",
        "creator_id": 80011,
        "created_at": 1710000000,
        "updated_at": 1712000000,
        "person_ids": [
          80011
        ],
        "description": "",
        "updated_by_name": "",
        "updated_by": 0,
        "creator_name": "alice",
        "ref_id": ""
      }
    ]
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InvalidParameter",
    "message": "The specified parameter is not valid."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "Unauthorized",
    "message": "You are unauthorized."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "RequestTooFrequently",
    "message": "Request too frequently."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InternalError",
    "message": "We encountered an internal error, and it has been reported. Please try again later."
  }
}

Restrictions

Aspect	Value
Rate limits	1,000 requests/minute; 50 requests/second per account
Permissions	None — any valid app_key can call this operation

Usage

• Filter by person_id to return teams that a specific person belongs to.
• Defaults: p=1, limit=20.

Authorizations

app_key · string · query · required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json

Filters for listing teams.

p · integer · default: 1

Page number. Default: 1.

Required range: x >= 1

limit · integer · default: 20

Page size. Max: 100. Default: 20.

Required range: 1 <= x <= 100

orderby · enum<string>

Sort field.

Available options: created_at, updated_at, team_name

asc · boolean

Ascending sort order.

person_id · integer<uint64>

Filter by member ID — return only teams this person belongs to.

query · string

Substring match on team name.

Response

200

application/json

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id · string · required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · required

Paginated team list.

Show child attributes