List Team members - Astronomer

GET

/

organizations

/

{organizationId}

/

teams

/

{teamId}

/

members

Error

A valid request URL is required to generate request examples

{
  "limit": 10,
  "offset": 0,
  "teamMembers": [
    {
      "userId": "clma5vzk2000108k20jhq3f7n",
      "username": "user1@company.com",
      "avatarUrl": "https://avatar.url",
      "createdAt": "2022-11-22T04:37:12Z",
      "fullName": "Jane Doe"
    }
  ],
  "totalCount": 100
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

organizationId

string

required

The ID of the Organization to which the Team belongs.

teamId

string

required

The ID of the Team to retrieve member information for.

Query Parameters

offset

integer

default:0

Offset for pagination

Required range: x >= 0

limit

integer

default:20

Limit for pagination

Required range: x >= 0

sorts

enum<string>[]

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

Available options:

userId:asc,

userId:desc,

fullName:asc,

fullName:desc,

username:asc,

username:desc,

createdAt:asc,

createdAt:desc

Response

OK

limit

integer

required

The maximum number of Team members in one page.

Example:

10

offset

integer

required

The offset of the current page of Team members.

Example:

0

teamMembers

object[]

required

The list of Team members in the current page.

Show child attributes

totalCount

integer

required

The total number of Team members.

Example:

100

⌘I

Error

A valid request URL is required to generate request examples

{
  "limit": 10,
  "offset": 0,
  "teamMembers": [
    {
      "userId": "clma5vzk2000108k20jhq3f7n",
      "username": "user1@company.com",
      "avatarUrl": "https://avatar.url",
      "createdAt": "2022-11-22T04:37:12Z",
      "fullName": "Jane Doe"
    }
  ],
  "totalCount": 100
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}