Get Group - Terminal Use

GET

groups

{group_id}

Get Group

curl --request GET \
  --url https://api.example.com/groups/{group_id}

{
  "created_by": "<string>",
  "id": "<string>",
  "name": "<string>",
  "owner_org_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

Path Parameters

group_id

string

required

Response

Successful Response

created_by

string

required

member_id of the creator.

string

required

Access group id.

name

string

required

Group name.

owner_org_id

string

required

Owner organization id.

created_at

string<date-time> | null

Creation timestamp.

description

string | null

Optional group description.

updated_at

string<date-time> | null

Last update timestamp.

Update GroupUpdate group metadata.

Get Group

curl --request GET \
  --url https://api.example.com/groups/{group_id}

{
  "created_by": "<string>",
  "id": "<string>",
  "name": "<string>",
  "owner_org_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}