Explore documentation
  1. Welcome to Incidents 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Slack and other integrations ↗
    3. Tag on-call in Slack
    4. Mobile apps ↗
    5. Connecting external calendars
    6. Advanced guide
  4. Incident management
    1. Get started
    2. AI SRE investigations
    3. Post mortems
    4. Metadata & Catalog
    5. Screening alerts
    6. 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. Incidents API
    1. Getting an API token
    2. Pagination
    3. Monitors
    4. Heartbeats
    5. On-call & incidents
    6. Status pages
    7. Metadata
    8. Integrations
    9. Team members
      1. List all team members GET
      2. Get a single team member GET
      3. Invite a team member POST
      4. Update team member role POST
      5. Remove a team member by ID DELETE
      6. Remove a team member by e-mail DELETE
    10. Organization roles
    11. Usage
    12. Reporting

Get a single team member

Returns a single team member by their ID. This endpoint does not return pending invitations.

You can retrieve a specific member or invitation by providing an email query parameter in List all team members API.

The role attribute is the team member's role in the team your API token is scoped to. A user with different roles in different teams returns different values depending on which team's token you use. Possible values: admin, billing_admin, team_lead, responder, member, or custom. custom is returned when the user has a non-system custom role.

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

URL parameters

id
required string

The ID of the team member.

Query parameters

team_name
string

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

Headers

Authorization
required string

Bearer $TOKEN

200

Returns a single team member.

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",
      "role_id": 101,
      "mobile_app_platforms": [
        "ios",
        "android"
      ]
    }
  }
}
404

The team member with the specified ID was not found.

Response body

{
  "errors": "Resource type user with id = 101 was not found"
}

Response attributes

id
string

The ID of the user.

type
string

Always team_member.

attributes.email
string

The e-mail address of the member.

attributes.first_name
string or null

The first name of the member, or null when it isn't set.

attributes.last_name
string or null

The last name of the member, or null when it isn't set.

attributes.created_at
string

When the member's Better Stack account was created, in ISO 8601 format.

attributes.role
string

The role in the team your API token is scoped to: admin, billing_admin, team_lead, responder, member, or custom for a custom role.

attributes.role_id
integer

The ID of the role, the id of a role from List roles as a number.

attributes.mobile_app_platforms
array

The platforms the member's mobile apps receive push notifications on, ios and android, or empty when none.

Example cURL

Example
curl --request GET \
  --url "https://betterstack.com/api/v2/team-members/101" \
  --header "Authorization: Bearer $TOKEN"


Previous article

List all team members

Next article

Invite a team member