List

Description

Retrieve a list of teams.

Request

HTTP Method: GET

Query Parameter Description
include_drafts Optional Include draft teams in the response Default: false
per_page Optional Set the number of results returned per page.
page Optional Specify the page of results to return if there are multiple pages. Defaults to page 1.
curl -X GET \
  https://<<META.tenant.domain>>/api/v1/teams \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

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

Field description

Parameter Description
id The team ID.
name The team name.

Sample response

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