Skip to content

Get the workspace

GET
/v1/team
curl --request GET \
--url https://api.roundrobinbot.eu/v1/team \
--header 'Authorization: Bearer <token>'

The Slack workspace this key belongs to, and what its plan allows. Read the plan’s ceilings before a provisioning script hits them, rather than finding out from a refusal halfway through.

OK

Media typeapplication/json

The workspace the calling key belongs to.

object
id

The Slack workspace id.

string
name
string
domain

The workspace’s Slack domain, the {domain} in {domain}.slack.com.

null | string
isEnterpriseInstall

True when Round Robin is installed org-wide on an Enterprise Grid org rather than into this one workspace.

boolean
enterpriseId

The Enterprise Grid org id, when the workspace belongs to one.

null | string
plan

What the workspace’s plan allows.

object
code

The plan’s code, as billing knows it.

null | string
paid
boolean
maxRotations

The most rotations the workspace may have enabled, or -1 for unlimited.

integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
maxUsers

The most distinct people the workspace may have across its enabled rotations, or -1 for unlimited.

integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
Examplegenerated
{
"id": "example",
"name": "example",
"domain": "example",
"isEnterpriseInstall": true,
"enterpriseId": "example",
"plan": {
"code": "example",
"paid": true,
"maxRotations": 1,
"maxUsers": 1
}
}

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"
}