v1

latestSwagger 2.02026-08-06249.2 KB

User

Retrieves the collection of User resources.

get/users

x-auth-parim-timestampstring required

Current timestamp in seconds.

x-auth-parim-keystring required

The Public API Key for authentication.

X-PARiM-Domainstring required

An internal parameter. Not provided by API consumer.

x-auth-parim-signaturestring required

The signature string.

x-auth-parim-noncestring required

Unique nonce.

User collection response

idinteger

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_idstring

User ID in an external system. Nullable.

namestring

First and last name of the person. Nullable.

emailstring

is_candidateboolean

User is a member of staff.

is_subcontractorboolean

User is a subcontractor.

title'mr' | 'ms' | 'miss' | 'mrs' | 'dr' | 'prof'

Person salutation title, only applies to staff members. Nullable.

timezonestring

User timezone. E.g. 'Europe/London'.

parim_idstring

PARiM object UUID. Read-only.