Skip to content

Get a user group

GET
/v1/groups/{groupId}
curl --request GET \
--url https://api.roundrobinbot.eu/v1/groups/example \
--header 'Authorization: Bearer <token>'

One Slack user group, from the same synced directory, carrying the @handle it is mentioned by. This is how a user-group id inside a rotation becomes a name somebody recognises.

groupId
required
string

OK

Media typeapplication/json

A Slack user group. Served by GET /v1/groups/{groupId}, from the same synced directory.

object
id

The Slack user-group id.

string
teamId
string
name
null | string
handle

The @handle the group is mentioned by.

null | string
Examplegenerated
{
"id": "example",
"teamId": "example",
"name": "example",
"handle": "example"
}

Unauthorized

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Forbidden

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}