Skip to main content

List

Description

Retrieve a list of teams.

Request

HTTP Method: GET

Query ParameterDescription
include_draftsOptional Include draft teams in the response Default: false
curl -X GET \
https://<tenant-domain>/api/v1/teams \
-H 'content-type: application/json' \
-H 'x-user-email: <email-address>' \
-H 'x-user-token: <api-token>'

Response

A successful request will return a JSON Array describing teams in the Tines tenant.

Field description

ParameterDescription
idThe team ID.
nameThe team name.

Sample response

{
"teams": [
{
"id": 1,
"name": "Security Team"
},
{
"id": 2,
"name": "Engineering Team"
}
],
"meta": {
"current_page": "https://<tenant-domain>/api/v1/teams?per_page=20&page=1",
"previous_page": null,
"next_page": null,
"per_page": 20,
"pages": 1,
"count": 2
}
}