Members

List members

Returns the team's members, by name.

get/members

Request

  • Base URL
    https://api.spectate.net/v1
  • Auth
    HTTP bearer

Query parameters

filter[role]'owner' | 'manager' | 'admin' | 'member' | 'billing'

A member's role in the team: what they may do.

owner <br/> Everything, including billing and deleting the team. One per team.
manager <br/> Everything but billing and deleting the team.
admin <br/> Configure monitoring, alerting, incidents and status pages; can't manage members or API tokens.
member <br/> Read everything; manage monitors and incidents, acknowledge alerts.
billing <br/> Billing and support only.

Only members with this role.

pageinteger

Page number, from 1.

per_pageinteger

Members per page, 1 to 100.

Response

Paginated set of Member

current_pageinteger required
first_page_urlstring nullable required
frominteger nullable required
last_page_urlstring nullable required
last_pageinteger required
next_page_urlstring nullable required
pathstring nullable required

Base path for paginator generated URLs.

per_pageinteger required

Number of items shown per page.

prev_page_urlstring nullable required
tointeger nullable required

Number of the last item in the slice.

totalinteger required

Total number of items being paginated.

Example response

{
  "data": [
    {
      "name": "Jane Doe",
      "email": "jane@example.com"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.