Skip to main content
GET
List users
All users in the organization can be viewed by project-scoped API keys

Authorizations

Authorization
string
header
required

Use a user token to access authenticated routes. The token must be specified in the Authorization HTTP header with the following format 'Authorization: Bearer '.

Headers

X-Phare-Project-Id
integer

A project header is required when using an organization-scoped API key.

Example:

1

X-Phare-Project-Slug
string

A project header is required when using an organization-scoped API key.

Example:

"luminous-guiding-tower"

Query Parameters

email
string

Filter users by email. Can be specified multiple times to filter by multiple email addresses.

page
integer
default:1

Page number to show

Example:

1

per_page
integer
default:20

Number of resources to return per page

Required range: 1 <= x <= 100
Example:

20

Response

Success, users retrieved

data
object[]
meta
object

Meta data for pagination

Links for pagination

Last modified on February 12, 2026