Get Team

Retrieve a team

GET/api/teams/{id}

Use it in a workflow

Add a step and choose the Gorgias connector.
Pick the Get Team action (under Teams).
Fill in the fields below, then reference the result from later steps as {{getTeam.response.data}}.

Request

Path parameters

idintegerrequired

The ID of the team to retrieve.

Response

Returns 200 with an object. Read it in later steps with {{getTeam.response.data.<field>}}.

idinteger

ID of the team.

uristring

URI of the object (auto-generated)

namestring

Name of the team.

descriptionstring | null

Longer description of the team.

decorationobject | null

Object describing how the team appears on the webpage. Currently only supports `emoji` field that shows before the team's name.

membersarray<object>

The list of users within the team.

idinteger

ID of the object

namestring | null

The full name of the user

emailstring | null

The email address of the user

metanull

User defined JSON field. It can be useful for storing additional info about the object.

created_datetimestring | null

When the team was created.

json

{
  "id": 123,
  "uri": "string",
  "name": "Warehouse team",
  "description": "string",
  "decoration": {},
  "members": [
    {
      "id": 0,
      "name": "Marie Curie",
      "email": "marie@gorgias.io",
      "meta": {}
    }
  ],
  "created_datetime": "2025-01-01T00:00:00Z"
}

Need more? See the Gorgias guide for connection setup and behaviour shared by every action.

Was this page helpful?