Skip to main content
GET
/
api
/
svc
/
v1
/
teams
/
user
List teams
curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/teams/user \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "jqfwg345gi25n5ju2yz5iz6m",
      "description": "<string>",
      "tenantName": "<string>",
      "accountId": "<string>",
      "createdBySubject": {
        "subjectId": "<string>",
        "subjectSlug": "<string>",
        "subjectDisplayName": "<string>",
        "subjectPatName": "<string>",
        "subjectControllerName": "<string>",
        "subjectExternalIdentitySlug": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "manifest": {
        "type": "team",
        "name": "<string>",
        "members": [
          "<string>"
        ],
        "displayName": "<string>",
        "description": "<string>",
        "managers": [
          "<string>"
        ],
        "ownedBy": {
          "account": "<string>"
        },
        "tags": {},
        "identity_provider_mapping": [
          {
            "identity_provider": "<string>",
            "value": "<string>"
          }
        ]
      },
      "isEditable": true,
      "members": [
        "<string>"
      ],
      "metadata": {
        "createdByScim": true,
        "scimExternalId": "<string>"
      },
      "roles": [
        "<string>"
      ],
      "topMembers": [
        "<string>"
      ],
      "topManagers": [
        "<string>"
      ],
      "totalMemberCount": 123,
      "totalManagerCount": 123
    }
  ],
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer | null
default:100

Number of items per page

Required range: 1 <= x <= 1000
Example:

10

​
offset
integer | null
default:0

Number of items to skip

Required range: x >= 0
Example:

0

​
type
enum<string> | null

Filter teams by type.

Available options:
team,
sso-team
Example:

"team"

​
attributes
string[] | null

Comma-separated list of attributes to return (e.g. id,teamName). When provided, only the specified fields are fetched. id is always included.

Example:

"id,teamName,manifest"

Response

200 - application/json

Paginated list of teams the caller has access to.

​
data
TeamDto · object[]
required

Array of teams matching the query.

​
pagination
Pagination · object
required

Pagination metadata.