Skip to main content
GET
List all Users

Authorizations

Authorization
string
header
required

Authenticate using a Honeycomb Management Key.

Pass the Management Key as a Bearer token in the Authorization header:

Construct the key value by joining the Key ID and Secret with a colon (:).

To learn how to create a Management Key, visit Manage Team API Keys. To learn more about authenticating requests, visit API Authentication.

Scopes

users:read

Path Parameters

teamSlug
string
required

The slug of the Team

Query Parameters

page[after]
string

The string value of the next attribute from a previous result page. The cursor value must be empty or omitted for the first request of a cursor-paginated query.

page[size]
number
default:20

The number of entries to include per response. Maximum value is 100.

Required range: 1 <= x <= 100
filter[email]
string<email>

Returns only the user with this email address. Matching ignores case.

filter[group]
string

Returns only members of the Group with this ID. Requires the groups:read scope as well. Returns 404 when the Team has no Group with this ID.

Response

Success

data
object[]
required

Links to iterate through the pages of results.