Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Slack and other integrations ↗
    3. Connecting external calendars
    4. Advanced guide
  4. Incidents
    1. Get started
    2. Advanced guide
    3. Reporting ↗
  5. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Uptime API
    1. Getting an API token
    2. Monitors
    3. Heartbeats
    4. On-call & incidents
    5. Status pages
    6. Metadata
    7. Integrations
    8. Team members
      1. List all team members GET
      2. Get a single team member GET
      3. Invite a team member POST
      4. Remove a team member by ID DELETE
      5. Remove a team member by e-mail DELETE

List all team members

List all team members and pending invitations. This endpoint supports pagination.

You can also retrieve a specific member or invitation by providing an email query parameter.

GET https://betterstack.com/api/v2/team-members

Query parameters

team_name
string

Required if using a global API token to specify the team.

email
string

Filter by a specific email address. If provided, returns a single member or invitation object instead of a list.

Headers

Authorization
required string

Bearer $TOKEN

200

Returns a list of team members and pending invitations.

Response body

{
  "data": [
    {
      "id": "101",
      "type": "team_member",
      "attributes": {
        "email": "alice@example.com",
        "first_name": "Alice",
        "last_name": "Smith",
        "created_at": "2023-10-26T10:00:00.000Z",
        "role": "admin"
      }
    },
    {
      "id": "102",
      "type": "team_member",
      "attributes": {
        "email": "bob@example.com",
        "first_name": "Bob",
        "last_name": "Johnson",
        "created_at": "2023-10-27T11:00:00.000Z",
        "role": "responder"
      }
    },
    {
      "id": "201",
      "type": "team_member_invitation",
      "attributes": {
        "email": "charlie@example.com",
        "invited_at": "2023-10-28T12:00:00.000Z",
        "role": "member"
      }
    }
  ],
  "pagination": {
    "first": "https://betterstack.com/api/v2/team-members?page=1",
    "last": "https://betterstack.com/api/v2/team-members?page=1",
    "prev": null,
    "next": null
  }
}
200

When using the email parameter, returns a single object.

Response body

{
  "data": {
    "id": "101",
    "type": "team_member",
    "attributes": {
      "email": "alice@example.com",
      "first_name": "Alice",
      "last_name": "Smith",
      "created_at": "2023-10-26T10:00:00.000Z",
      "role": "admin"
    }
  }
}
404

No team member or invitation with the specified email was found.

Response body

{
  "errors": "Team member with email \"nonexistent@example.com\" not found"
}
422

A global API token has access to multiple teams, and no team_name was provided.

Response body

{
  "errors": "This token has access to multiple teams. Please use the 'team_name' parameter to specify the team."
}
401

Authentication failed due to missing or invalid token.

Response body

{
  "errors": "We could not authenticate your request. Please provide a valid Global API token or Uptime API token."
}

Example cURL

List all members Find by email 
curl --request GET \
  --url "https://betterstack.com/api/v2/team-members" \
  --header "Authorization: Bearer $TOKEN"
curl --request GET \
  --url "https://betterstack.com/api/v2/team-members?email=alice@example.com" \
  --header "Authorization: Bearer $TOKEN"


Previous article

Response attributes

Next article

Get a single team member