Skip to main content
GET
/
v2
/
teams
/
{teamId}
Get a team by ID
curl --request GET \
  --url https://rest.forestreet.com/v2/teams/{teamId} \
  --header 'x-api-key: <api-key>'
{
  "id": 123,
  "name": "<string>",
  "domain": "<string>",
  "filePath": "<string>",
  "explorerPermissions": {
    "table": true,
    "bubble": true,
    "events": true,
    "feature-fit": true,
    "due-diligence": true
  },
  "accessExpired": 123,
  "maxUsers": 123,
  "isDemo": 123,
  "theme": "<string>",
  "isDefault": 123
}

Authorizations

​
x-api-key
string
header
required

Pass a static API key for every request, provided by your customer support.

Path Parameters

​
teamId
integer
required

ID of the team whose collections are being retrieved. ID of the team whose collections are being retrieved.

Required range: x > 0

Response

Get team response

​
id
number
required

Unique identifier of the team.

​
name
string | null
required

Name of the team.

​
domain
string | null
required

Domain of the team.

​
filePath
string | null
required

File path for the team.

​
explorerPermissions
object
required

Permission settings for explorer features.

​
accessExpired
number
required

Access expiration status.

​
maxUsers
number
required

Maximum number of users allowed.

​
isDemo
number
required

Demo status of the team.

​
theme
string | null
required

Theme settings for the team.

​
isDefault
number

Default state of the team.