getTeam

A Graze API GET request that returns a team's details by team ID or name.

Back to Graze API EndPoint Reference.

Request arguments

Endpoint getTeam takes the following request arguments:

Name

Type

Required

Description

auth_token

String

Yes

A valid auth_token returned from the authenticate request. See the authenticate endpoint for more information.

team_id

Integer

Yes

Unique ID of the team to retrieve information about.

name

String

Yes

Name of a valid team to retrieve information about.

Response

Endpoint getTeam returns the following response:

Successful requests return a JSON object containing the following:

Type

Description

JSON Object

A JSON object containing details of the specified team.

Examples

The following examples demonstrate typical use of endpoint getTeam:

Request examples

Example cURL request to return details of the team ID 1:

curl -G -u graze:graze -k -v "https://localhost/graze/v1/getTeam?team_id=1"

Example cURL request to return details of the team "Cloud DevOps:

curl -G -u graze:graze -k -v "https://localhost/graze/v1/getTeam" --data-urlencode 'name=Cloud DevOps'

Response example

Example response returning details of the team:

{
  "room_id": 1,
  "alert_filter": "((severity = 0) OR (severity = 1)) AND (agent_location = \"Test\")",
  "user_ids": [
    3
  ],
  "sig_filter": "((internal_priority = 0) AND (internal_priority = 1)) OR (description = \"Test\")",
  "landing_page": "",
  "description": "",
  "active": true,
  "team_id": 1,
  "services": [],
  "users": [
    "admin"
  ],
  "deleted": false,
  "name": "Cloud DevOps",
  "service_ids": []
}