Users

Get a Collection of Users

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

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

Query parameters

departmentIdinteger

An optional department to filter the users

includeArchivedUsersboolean

Whether to include archived users in the search results

onlyShowArchivedUsersboolean

If archived users are included, should we ONLY show those.

Response

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

idinteger

The unique Id for this user

firstnamestring nullable

The user's first name

surnamestring nullable

The user's surname

emailstring nullable

The user's email

adminboolean

Whether this user is an admin

directorboolean

Whether this user is set as a Director

accountOwnerboolean

Whether this user is an Account Owner

organisationIdinteger

The organisation Id of this user

departmentIdinteger

The department Id of this user

allowanceUnit'Days' | 'Hours'

The allowance unit for the user - Days or Hours

  • Days
  • Hours
managerOfDepartmentsinteger[] nullable

A comma-separated list of department ids that this user is a manager of

bossOfDepartmentsinteger[] nullable
endDatestring date-time nullable

If set, the date that the user was archived

departmentNamestring nullable

The name of the department this user belongs to

gravatarstring nullable

The URL of the avatar/gravatar resource for this user

allowanceRemainingnumber double

The allowance remaining for this user, for the current year

hasLoggedOnboolean

Whether this user has logged on

isArchivedboolean

Whether this user is archived

approverIdinteger

If the user has a specific approver set, this is the Id of that user

isApproverboolean
deptManagerIdinteger

The Id of the user who is the manager of the department this user belongs to

deptBossIdinteger

We no longer use the word Boss - this parameter may be removed in future, use deptManagerId

birthdaystring date-time nullable

The birthday of this user

startDatestring date-time nullable

The start date for this user

hasPublicHolidaysboolean

If this user has public holidays

userInitialsstring nullable

The user initials

countryCodestring nullable

The country code this user has public holidays for (ZZ if custom location)

currentYearAllowancenumber double

The allowance for this user, for the current leave year

nextYearAllowancenumber double

The allowance for this user, for the next leave year

userLinkedWithGoogleboolean
userManagedExternallyboolean
mfaEnabledboolean
inviteSentTimeUtcstring date-time nullable
inviteSentTimeHumanisedstring nullable
yearStartinteger

The month that the user's leave year starts (1 being January to 12 being December)

accrualSystemboolean
isEmailConfirmedboolean

Changes

No recorded changes to this operation across all 1 revision of this API.