plnnrlydevelopers

Deze referentie is alleen in het Engels. Naar het Nederlandse REST API-overzicht

Diese Referenz gibt es nur auf Englisch. Zur deutschen REST-API-Übersicht

Cette référence existe uniquement en anglais. Aller à la présentation de l'API REST en français

Esta referencia solo está en inglés. Ir a la introducción de la API REST en español

User

User

A user: one member of the organisation, as plnnrly's people list shows them.

View as Markdown
Summary view
UserList, 14 fields. What a list returns by default.
Detail view
User, 16 fields. The default for a single read and for every write.
Read with
api:read

Read-only: the API creates, updates and deletes no user, because password setting belongs to the invitation and reset flows and because roles, permissions and teams are out of scope as resources and as writable relations. Service accounts are never returned: a system user is absent from the collection and 404 by id. A soft-deleted user stays readable with trashed=with, which is how a sync client learns an employee left.

Used by

GETRead the token owner/meUser
GETList users/usersUserList
GETRead a user/users/{user}User

Fields

Detail only
Only in the detail view.
Only with include
Only when you ask for it with include.
Server-assigned
Set by plnnrly, never by a request.
idinteger

Unique identifier.

namestring≤ 255

Full name as shown throughout plnnrly. Searchable with ?q=.

emailstring≤ 255

Work email address, unique within the organisation. Searchable with ?q=, which is the practical way to resolve a person to an id.

colorstring≤ 255

The user's identifying colour, as a CSS colour string. Used by plnnrly's calendars and avatars; render it or ignore it.

job_titlestring≤ 255

Job title, e.g. Project Manager.

phone_numberstring or null≤ 255

Phone number as entered, in no normalised format.

timezonestring or null≤ 255

The user's own IANA timezone, e.g. Europe/Amsterdam. Null means the organisation's default applies. Every timestamp in this API is UTC regardless; this is the zone a client renders them in for this person.

date_employeddate (YYYY-MM-DD) or null

First day of employment, or null where it was never recorded. A calendar date with no clock, so it is never converted to UTC.

birthdaydate (YYYY-MM-DD) or null

Date of birth, or null where it was never recorded.

profitability_target_percentageinteger or null

Share of available hours this person is expected to bill, 1 to 100, or null where no target is set. Read by the profitability report; a user without a target is still reported on, just not judged against one.

Variants

UserList 14 fields

What a collection returns, and what ?view=summary returns on a single record.

Leaves out: working_hours, work_locations

UserSummary 2 fields

The embedded form: what you get when another resource carries this one and you did not include it.

Leaves out: email, color, job_title, phone_number, timezone, date_employed, birthday, profitability_target_percentage, working_hours, work_locations, created_at, updated_at, deleted_at, links

UserLinks 1 field

The links object on this resource.

Keys: self

Columns deliberately not published

infoscreenThe user's info screen choice in plnnrly; meaningless to an API client.
settingsPer-user display preferences of the plnnrly app, with no meaning for an API client.