---
title: "List users"
method: GET
path: "/users"
tags: ["Users"]
---

# List users

`GET /users`

## Request

- Base URL: `https://api.heffl.com/api/v1`
- URL: `https://api.heffl.com/api/v1/users`
- Auth: API key in header `x-api-key`

Returns a paginated list of users who belong to the API key's team.

## Query parameters

- `cursor` string
- `limit` number
- `search` string
- `active` boolean

## Response `200`

OK

- object
  - `items` object[], required
    - `id` string, required: User public ID
    - `firstName` string, required: First name
    - `lastName` string, nullable: Last name
    - `email` string, required: Email address
    - `jobTitle` string, nullable: Job title
    - `role` string, required: Team role
    - `createdAt` string, date-time, required: When the user was created
  - `nextCursor` string, nullable: Cursor to fetch the next page. Null if there are no more results.
  - `hasMore` boolean, required: Whether additional results are available

---

[API](https://skmtc.dev/heffl/apis/heffl-public-api-legacy-v1.md) · [All operations](https://skmtc.dev/heffl/apis/heffl-public-api-legacy-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/heffl/apis/heffl-public-api-legacy-v1/revisions/9bdb229223a2?raw)