List Teams | Astronomer Documentation

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

{
  "limit": 10,
  "offset": 0,
  "teams": [
    {
      "createdAt": "2022-11-22T04:37:12Z",
      "id": "clma5ftgk000008mhgev00k7d",
      "isIdpManaged": false,
      "name": "My Team",
      "organizationId": "clma5g8q6000108mh88g27k1y",
      "organizationRole": "ORGANIZATION_MEMBER",
      "updatedAt": "2022-11-22T04:37:12Z",
      "createdBy": {
        "id": "clm8qv74h000008mlf08scq7k",
        "apiTokenName": "my-token",
        "avatarUrl": "https://avatar.url",
        "fullName": "Jane Doe",
        "subjectType": "USER",
        "username": "user1@company.com"
      },
      "dagRoles": [
        {
          "deploymentId": "clm8t5u4q000008jq4qoc3031",
          "role": "DAG_VIEWER",
          "dagId": "my_dag",
          "dagTag": "team-a"
        }
      ],
      "deploymentRoles": [
        {
          "deploymentId": "clm8t5u4q000008jq4qoc3031",
          "role": "DEPLOYMENT_ADMIN"
        }
      ],
      "description": "My Team description",
      "rolesCount": 1,
      "updatedBy": {
        "id": "clm8qv74h000008mlf08scq7k",
        "apiTokenName": "my-token",
        "avatarUrl": "https://avatar.url",
        "fullName": "Jane Doe",
        "subjectType": "USER",
        "username": "user1@company.com"
      },
      "workspaceRoles": [
        {
          "role": "WORKSPACE_MEMBER",
          "workspaceId": "clm8t5u4q000008jq4qoc3036"
        }
      ]
    }
  ],
  "totalCount": 100
}

List all Teams in an Organization. Optionally filter by Workspace or Deployment membership.

Authentication

AuthorizationBearer

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

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.

workspaceIdstringOptional

The ID of the Workspace to filter the list of Teams for. When specified, the API returns only Teams with a role in the specified Workspace.

deploymentIdstringOptional

The ID of the Deployment to filter the list of Teams for. When specified, the API returns only Teams with a role in the specified Deployment.

offsetintegerOptional>=0Defaults to 0

Offset for pagination

limitintegerOptional0-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.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error