Team

List Teams

GET
List all Teams in an Organization.

Path parameters

organizationIdstringRequired
ID of the Organization to list Teams for.

Query parameters

namesstringOptional
A list of names for Teams to filter by. The API returns details only for the specified Teams.
offsetintegerOptional
Offset for pagination
limitintegerOptional
Limit for pagination
sortsenumOptional
Sorting criteria, each criterion should conform to format 'fieldName:asc' or 'fieldName:desc'

Response

This endpoint returns an object
limit
integer
The maximum number of Teams in one page.
offset
integer
The offset of the current page of Teams.
teams
list of objects
The list of Teams in the current page.
totalCount
integer
The total number of Teams.
GET
1curl https://api.astronomer.io/iam/v1beta1/organizations/organizationId/teams \
2     -H "Authorization: Bearer <token>"
200Retrieved
1{
2  "limit": 10,
3  "offset": 0,
4  "teams": [
5    {
6      "createdAt": "2022-11-22T04:37:12Z",
7      "id": "clma5ftgk000008mhgev00k7d",
8      "isIdpManaged": false,
9      "name": "My Team",
10      "organizationId": "clma5g8q6000108mh88g27k1y",
11      "organizationRole": "ORGANIZATION_OWNER",
12      "updatedAt": "2022-11-22T04:37:12Z",
13      "createdBy": {
14        "id": "clm8qv74h000008mlf08scq7k",
15        "apiTokenName": "my-token",
16        "avatarUrl": "https://avatar.url",
17        "fullName": "Jane Doe",
18        "username": "user1@company.com"
19      },
20      "deploymentRoles": [
21        {
22          "deploymentId": "clm8t5u4q000008jq4qoc3031",
23          "role": "DEPLOYMENT_ADMIN"
24        }
25      ],
26      "description": "My Team description",
27      "rolesCount": 1,
28      "updatedBy": {
29        "id": "clm8qv74h000008mlf08scq7k",
30        "apiTokenName": "my-token",
31        "avatarUrl": "https://avatar.url",
32        "fullName": "Jane Doe",
33        "username": "user1@company.com"
34      },
35      "workspaceRoles": [
36        {
37          "role": "WORKSPACE_OWNER",
38          "workspaceId": "clm8t5u4q000008jq4qoc3036"
39        }
40      ]
41    }
42  ],
43  "totalCount": 100
44}
Built with