Skip to main content
POST
Get team detail

Restrictions

Usage

  • At least one of team_id, team_name, or ref_id must be provided.

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

Request identifying a team by one of ID, name, or external ref.

team_id
integer<uint64>

Team ID. At least one of the three lookup fields is required; lowest priority — only used when neither ref_id nor team_name is provided.

team_name
string

Team name. Only used when ref_id is not provided; takes precedence over team_id.

ref_id
string

External reference ID. When provided, takes precedence over team_name and team_id.

Response

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

A team and its membership.