---
title: "Get a Collection of Users"
method: GET
path: "/api/users"
tags: ["Users"]
---

# Get a Collection of Users

`GET /api/users`

## Request

- Base URL: `https://app.timetastic.co.uk` (the document declares no server; this is the origin it was published from)
- URL: `https://app.timetastic.co.uk/api/users`
- Auth: none declared

Get a Collection of Users for your organisation, optionally filtered by a department.

## Query parameters

- `departmentId` integer
- `includeArchivedUsers` boolean
- `onlyShowArchivedUsers` boolean

## Response `200`

The users you are allowed to see. Department managers only ever see their own departments.

- TimetasticWebApiResourceModelsUser[]
  - `id` integer: The unique Id for this user
  - `firstname` string, nullable: The user's first name
  - `surname` string, nullable: The user's surname
  - `email` string, nullable: The user's email
  - `admin` boolean: Whether this user is an admin
  - `director` boolean: Whether this user is set as a Director
  - `accountOwner` boolean: Whether this user is an Account Owner
  - `organisationId` integer: The organisation Id of this user
  - `departmentId` integer: The department Id of this user
  - `allowanceUnit` 'Days' | 'Hours': The allowance unit for the user - Days or Hours - `Days` - `Hours`
  - `managerOfDepartments` integer[], nullable: A comma-separated list of department ids that this user is a manager of
  - `bossOfDepartments` integer[], nullable
  - `endDate` string, date-time, nullable: If set, the date that the user was archived
  - `departmentName` string, nullable: The name of the department this user belongs to
  - `gravatar` string, nullable: The URL of the avatar/gravatar resource for this user
  - `allowanceRemaining` number, double: The allowance remaining for this user, for the current year
  - `hasLoggedOn` boolean: Whether this user has logged on
  - `isArchived` boolean: Whether this user is archived
  - `approverId` integer: If the user has a specific approver set, this is the Id of that user
  - `isApprover` boolean
  - `deptManagerId` integer: The Id of the user who is the manager of the department this user belongs to
  - `deptBossId` integer: We no longer use the word Boss - this parameter may be removed in future, use deptManagerId
  - `birthday` string, date-time, nullable: The birthday of this user
  - `startDate` string, date-time, nullable: The start date for this user
  - `hasPublicHolidays` boolean: If this user has public holidays
  - `userInitials` string, nullable: The user initials
  - `countryCode` string, nullable: The country code this user has public holidays for (ZZ if custom location)
  - `currentYearAllowance` number, double: The allowance for this user, for the current leave year
  - `nextYearAllowance` number, double: The allowance for this user, for the next leave year
  - `userLinkedWithGoogle` boolean
  - `userManagedExternally` boolean
  - `mfaEnabled` boolean
  - `inviteSentTimeUtc` string, date-time, nullable
  - `inviteSentTimeHumanised` string, nullable
  - `yearStart` integer: The month that the user's leave year starts (1 being January to 12 being December)
  - `accrualSystem` boolean
  - `isEmailConfirmed` boolean

## Other responses

- `401`: The request was not authenticated — the API token is missing or invalid.
- `403`: You are neither an administrator nor a department manager, or the `departmentId` filter does not exist or belongs to another organisation.

---

[API](https://skmtc.dev/timetastic/apis/timetastic-api.md) · [All operations](https://skmtc.dev/timetastic/apis/timetastic-api/llms.txt) · [OpenAPI document](https://skmtc.dev/timetastic/apis/timetastic-api/revisions/709ccb0412c3?raw)