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.

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": "inv_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"
    }
  }
}

Example cURL

List all members Find by email

Copied!

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"

Looking for the details of a specific parameter?

Explore [the list of all Team Members API parameters][docs-uptime-api-team-members-response-params].

Explore documentation

List all team members

Example cURL

Looking for the details of a specific parameter?

Please accept cookies