Moogsoft Docs

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:

Name

Type

Description

JSON Object

JSON

Details of a 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?name=Cloud DevOps"
Response example

Example response returning the details of the team:

{
    "room_id": 1,
    "alert_filter": "",
    "user_ids": [
        3
    ],
    "sig_filter": "",
    "landing_page": null,
    "description": "Example Team",
    "active": true,
    "team_id": 1,
    "services": [],
    "users": [
        "admin"
    ],
    "name": "Cloud DevOps",
    "service_ids": []
}