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

# List users

`GET /api/users`

Retrieves a paginated list of users in the organisation with optional filtering by service account type and search term.

## Query parameters

- `isService` string
- `search` string
- `page` number
- `perPage` number

## Response `200`

Paginated list of users

- object — Paginated list of users
  - `results` object[], required — List of users
    - `id` string, uuid, required — Unique identifier of the user
    - `email` string, email, required — Email address of the user
    - `firstName` string, nullable — First name of the user
    - `lastName` string, nullable — Last name of the user
    - `type` 'invited' | 'member' | 'author' | 'admin' | 'owner', required — User type/role within the organisation
    - `status` 'active' | 'disabled' | 'locked', required — Current status of the user account
    - `isService` boolean — Whether this is a service account
    - `roles` object[] — Roles assigned to the user
      - `id` string, uuid, required — Unique identifier of the role
      - `name` string, required — Name of the role
      - `description` string, nullable — Description of the role
    - `createdAt` string, required — Timestamp when the user was created
    - `updatedAt` string, required — Timestamp when the user was last updated
  - `paginate` object, required — Pagination metadata
    - `current` number, required — Current page number
    - `from` number, required — Starting record number
    - `to` number, required — Ending record number
    - `total` number, required — Total number of records
    - `pageSize` number, required — Number of records per page

---

[API](https://skmtc.dev/gorules/apis/gorules-agent-api.md) · [All operations](https://skmtc.dev/gorules/apis/gorules-agent-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/gorules/gorules-agent-api/revisions/52c0773fcd80/schema)