Skip to main content
GET
List the company's users

Authorizations

Authorization
string
header
required

Supabase JWT — Authorization: Bearer <token>.

Query Parameters

merchant_id
string<uuid>

Optional merchant to scope to. Admins and sub-merchant operators only; other callers always use their token's merchant.

Example:

"28106cba-1c27-4e53-b149-32113e5e8e31"

filter_text
string

Only users whose name or e-mail contains this text.

Maximum string length: 200
role
enum<string>

Only users with this role.

Available options:
owner,
recruiter,
reader,
admin
include_inactive
enum<string>
default:false

true: also invited and disabled users (deleted ones never).

Available options:
true,
false
Example:

"false"

position_id
string<uuid>

Only the users with a role on this multi-stage position (from merchant-interview-list), each with position_roles. A team role held through a group counts when you may see the group's members.

Response

The users.

data
object[]
required

The users, by name (at most 2000).