---
title: "Retrieves the collection of User resources."
method: GET
path: "/users"
tags: ["User"]
---

# Retrieves the collection of User resources.

`GET /users`

## Headers

- `x-auth-parim-timestamp` string, required
- `x-auth-parim-key` string, required
- `X-PARiM-Domain` string, required
- `x-auth-parim-signature` string, required
- `x-auth-parim-nonce` string, required

## Response `200`

User collection response

- User[] — List of User resources.
  - `id` integer — User ID. Read-only.
  - `status` 'active_incomplete' | 'active_complete' | 'active_approved' — User status. 'active_incomplete' - registration not completed, 'active_complete' - registration completed, 'active_approved' - approved.
  - `external_id` string — User ID in an external system. Nullable.
  - `name` string — First and last name of the person. Nullable.
  - `email` string
  - `is_candidate` boolean — User is a member of staff.
  - `is_subcontractor` boolean — User is a subcontractor.
  - `title` 'mr' | 'ms' | 'miss' | 'mrs' | 'dr' | 'prof' — Person salutation title, only applies to staff members. Nullable.
  - `timezone` string — User timezone. E.g. 'Europe/London'.
  - `parim_id` string — PARiM object UUID. Read-only.

## Other responses

- `400` — Invalid request message or headers.
- `401` — Request not authorized.
- `500` — 500 response

---

[API](https://skmtc.dev/parim/apis/clockingapi.md) · [All operations](https://skmtc.dev/parim/apis/clockingapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/parim/clockingapi/revisions/c9518eb0d4c8/schema)