GET api/v1/Teams/{id}

Gets a specific team

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID of the team

globally unique identifier

Required

fields

Use this to only return the data fields you're interested in. Field names not found are ignored and no error is thrown. If no fields are found then the full object is returned.

Collection of string

None.

suppressResponseCodes

Some applications do wonky things if error codes are used. Use this to force 200s to always return.

boolean

None.

APIKey

This is your unique key that identifies you as the developer of this app. Required for all calls.

string

None.

APIToken

This is the user's session token generated when you authenticate the user

string

None.

Body Parameters

None.

Response Information

Resource Description

Team
NameDescriptionTypeAdditional information
ID

Team's ID

globally unique identifier

None.

Name

Team's name

string

None.

OUName

Team's OU's name

string

None.

OUID

Team's OU ID

globally unique identifier

None.

LeaderFName

Team's leader's first name

string

None.

LeaderLName

Team's leader's last name

string

None.

LeaderID

Team's lead user ID

globally unique identifier

None.

ParentIDs

Parent IDs of this team

Collection of globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
{
  "ID": "cb5a60bd-afc5-4231-be1d-a4fbdf091946",
  "Name": "sample string 2",
  "OUName": "sample string 3",
  "OUID": "fa86d18e-ec39-434e-97b3-891a8d933949",
  "LeaderFName": "sample string 5",
  "LeaderLName": "sample string 6",
  "LeaderID": "d27f3723-4f57-46c8-9850-d1231d29b621",
  "ParentIDs": [
    "f1e6bf6f-af42-4263-b25a-1259623e3df1",
    "d19645dc-72fe-4c19-badd-9e8c3a0cdbfc"
  ]
}