Skip to main content
GET
Retrieve an employee-attribute
This API endpoint is in beta and may be subject to changes, including breaking changes (similarly to the legacy API endpoints), without prior notice. Read more about versioning.
OAuth 2.0 scopes
or

EstablishmentsThis API endpoint will filter out results based on accessible business-establishments.You may only access employee-attributes of employees whose applicable business-establishments are accessible to you.
ClaimsThis API endpoint will filter out results based on accessible claims.Each employee-attribute is associated with specific an employee directory “section”. You may only access employee-attributes attached to sections that are accessible to you.

Authorizations

Authorization
string
header
required

The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.

FlowClient Credentials
Token URL
https://accounts.world.luccasoftware.com/connect/token
Scopes1
employee-attributes.readonly
Read [employee-attributes](/api-reference/latest/employee-attributes/employee-attribute).

Headers

Api-Version
enum<string>
required

Set the API version.

Available options:
2024-11-01
Allowed value: "2024-11-01"
Maximum string length: 10
Example:

"2024-11-01"

If-None-Match
string

Only execute the request if current cached version of the resource does not match the one given here.

Example:

"W/q5sd4w2x1c1gfdg"

If-Match
string

Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.

Example:

"W/q5sd4w2x1c1gfdg"

Accept-Encoding
string

List of compression algorithms you support.

Path Parameters

id
string
required

Identifier of the employee-attribute.

Minimum string length: 1

Query Parameters

include
enum<string>[]

Include metadata:

  • embedded: the partial or complete representations of related resources (e.g. the employee the resource belongs to).
  • links: links to related resources or actions (e.g. approving a leave-request). May be null when you do not have access to the resource (or action).
  • totalCount: only applicable on collections (i.e. lists of resources), gives the total number of items across all pages.

Read more about expanding responses.

Available options:
embedded,
links,
totalCount

Response

OK

An employee-attribute resource.

id
string
Minimum string length: 1
type
string
Allowed value: "employee-attribute"
url
string<uri>
definition
employee-attribute-definition-reference · object
employee
employee-reference · object

Reference to an employee resource.

employment
employment-reference · object | null

Reference to an employment resource.

jobPosition
job-position-reference · object | null

Reference to a job-position resource.

applicability
null | object

The time window during which this attribute value applies to the employee.

Two periods are exposed side by side:

  • start / end describe the computed period. It is stretched to cover the gaps between two consecutive resources, so that the history of an attribute reads as an uninterrupted timeline. As a result it may span periods during which the employee had no contract at all.
  • strictStart / strictEnd describe the strict period, inherited from the source resource (employment, job-position) without any gap filling. Use it whenever contractual accuracy matters, typically to build point-in-time reports.

A null lower bound must be interpreted as "since the beginning of time", and a null upper bound as "until the end of time".

If the attribute has no temporal dimension (e.g. employee.givenName, custom extensions), all four dates are null. It must be interpreted as "applies indefinitely".

The applicability.asOf and applicability.strictAsOf query parameters can be used to filter by date, on the computed and on the strict period respectively.

value
createdAt
string<date-time>

Read-only. UTC timestamp of the moment this object was created. The UTC offset may be written Z or +00:00, with up to 7 fractional digits of a second.

Examples:

"2023-01-23T12:45:23.1234567+00:00"

"2023-01-23T12:45:23.1234Z"

lastUpdatedAt
string<date-time>

Read-only. UTC timestamp of the moment this object was last updated. Set upon creation, update or deletion of the object. The UTC offset may be written Z or +00:00, with up to 7 fractional digits of a second.

Examples:

"2023-01-23T12:45:23.1234567+00:00"

"2023-01-23T12:45:23.1234Z"

embedded
object | null

Embeds the representation of resources related to the employee-attribute(s).

Only returned if requested by the API client: ?include=embedded.