Users

Get a User & Contact details

Retrieves a specific user. In addition to the user detail, we return their work schedule, their allowances and any details from the Contact tab.

<span class='timetasticpro'><b> ℹ️ This endpoint is only accessible if you have a Timetastic Pro account </b></span>

get/api/users/contact/{id}

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/contact/{id}
  • Auth: none declared

Path parameters

idinteger required

Response

The user, with their work schedule, allowances and contact details.

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
jobTitlestring nullable

The user's job title

payrollIdstring nullable

The user's payroll ID (will be included in reports)

address1string nullable

First line of the address

address2string nullable

Address line 2

citystring nullable

Address line 3 / City

postCodestring nullable

Address line 4 / PostCode

telephone1string nullable

Primary contact number

telephone2string nullable

Secondary contact number

countrystring nullable

String: ALPHA-2 country code

emergencyContactNamestring nullable

Name of emergency contact

emergencyContactPhonestring nullable

Contact number of emergency contact

Changes

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