List Teams

1 curl https://api.astronomer.io/iam/v1beta1/organizations/organizationId/teams \ 2 -H "Authorization: Bearer <token>"

1 { 2 "limit": 10, 3 "offset": 0, 4 "teams": [ 5 { 6 "createdAt": "2022-11-22T04:37:12Z", 7 "createdBy": { 8 "apiTokenName": "my-token", 9 "avatarUrl": "https://avatar.url", 10 "fullName": "Jane Doe", 11 "id": "clm8qv74h000008mlf08scq7k", 12 "subjectType": "USER", 13 "username": "user1@company.com" 14 }, 15 "deploymentRoles": [ 16 { 17 "deploymentId": "clm8t5u4q000008jq4qoc3031", 18 "role": "DEPLOYMENT_ADMIN" 19 } 20 ], 21 "description": "My Team description", 22 "id": "clma5ftgk000008mhgev00k7d", 23 "isIdpManaged": false, 24 "name": "My Team", 25 "organizationId": "clma5g8q6000108mh88g27k1y", 26 "organizationRole": "ORGANIZATION_MEMBER", 27 "rolesCount": 1, 28 "updatedAt": "2022-11-22T04:37:12Z", 29 "updatedBy": { 30 "apiTokenName": "my-token", 31 "avatarUrl": "https://avatar.url", 32 "fullName": "Jane Doe", 33 "id": "clm8qv74h000008mlf08scq7k", 34 "subjectType": "USER", 35 "username": "user1@company.com" 36 }, 37 "workspaceRoles": [ 38 { 39 "role": "WORKSPACE_MEMBER", 40 "workspaceId": "clm8t5u4q000008jq4qoc3036" 41 } 42 ] 43 } 44 ], 45 "totalCount": 100 46 }

List all Teams in an Organization.

Path parameters

organizationIdstringRequired

ID of the Organization to list Teams for.

Query parameters

nameslist of stringsOptional

A list of names for Teams to filter by. The API returns details only for the specified Teams.

offsetintegerOptional>=0Defaults to 0

Offset for pagination

limitintegerOptional>=0<=1000Defaults to 20

Limit for pagination

sortslist of enumsOptional

Sorting criteria, each criterion should conform to format ‘fieldName:asc’ or ‘fieldName:desc’

Response

limitinteger

The maximum number of Teams in one page.

offsetinteger

The offset of the current page of Teams.

teamslist of objects

The list of Teams in the current page.

totalCountinteger

The total number of Teams.

Path parameters

Headers

Query parameters

Response

Errors