Skip to main content
POST
Get team detail

Restrictions

Usage

  • Provide one of team_id, team_name, or ref_id; when several are sent, ref_id wins over team_name, which wins over team_id.
  • Lookups by team_name or ref_id only match non-deleted teams; a lookup by team_id also returns a deleted team, with status deleted.
  • When no team matches, the call returns 400 InvalidParameter.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

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

team_id
integer<uint64>
required

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

A team and its membership.