List Members

GET

/api/v1/members

const url = 'https://api.ultimateteam.ai/api/v1/members';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.ultimateteam.ai/api/v1/members \
  --header 'X-API-Key: <X-API-Key>'

Return all non-removed memberships for the caller’s tenant.

Legacy owners without a persisted membership still occupy a chairman seat.

Authorizations

ApiKeyAuth

Responses

200

Successful Response

application/json

MemberListResponse

GET /api/v1/members response body.

object

members

required

Members

Array<object>

MemberRow

One row in GET /api/v1/members.

object

accepted_at

Any of:

string
null

string format: date-time

email

required

Email

string format: email

required

string format: uuid

invited_at

required

Invited At

string format: date-time

last_active_at

Any of:

string
null

string format: date-time

role

required

Role

string

Allowed values: chairman operator viewer

status

required

Status

string

Allowed values: invited active suspended removed

seat_limit

required

Any of:

integer
null

integer

seats_used

required

Seats Used

Active + invited members counted against the ceiling.

integer

Example

{
  "members": [
    {
      "role": "chairman",
      "status": "invited"
    }
  ]
}