List employee-attributes

curl --request GET \
  --url https://{host}/lucca-api/employee-attributes \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{host}/lucca-api/employee-attributes"

headers = {
    "Api-Version": "<api-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Api-Version': '<api-version>', Authorization: 'Bearer <token>'}
};

fetch('https://{host}/lucca-api/employee-attributes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/lucca-api/employee-attributes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Api-Version: <api-version>",
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/lucca-api/employee-attributes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Api-Version", "<api-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/lucca-api/employee-attributes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Api-Version"] = '<api-version>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "type": "employee-attributes",
  "url": "https://example.ilucca.net/lucca-api/employee-attributes?limit=10",
  "totalCount": 3489,
  "items": [
    {
      "id": "34879",
      "type": "employee-attribute",
      "url": "https://example.ilucca.net/lucca-api/employee-attribute/34879",
      "definition": {
        "id": "givenName",
        "type": "employee-attribute-definition",
        "url": "https://example.ilucca.net/lucca-api/employee-attribute-definitions/givenName"
      },
      "employee": {
        "id": "416",
        "type": "employee",
        "url": "https://example.ilucca.net/lucca-api/employees/416"
      },
      "applicability": null,
      "value": "John",
      "createdAt": "2014-04-12T09:43:52.432Z",
      "lastUpdatedAt": "2014-04-12T09:43:52.432Z",
      "links": {}
    },
    {
      "id": "34880",
      "type": "employee-attribute",
      "url": "https://example.ilucca.net/lucca-api/employee-attribute/34880",
      "definition": {
        "id": "jobPosition.manager",
        "type": "employee-attribute-definition",
        "url": "https://example.ilucca.net/lucca-api/employee-attribute-definitions/jobPosition.manager"
      },
      "employee": {
        "id": "416",
        "type": "employee",
        "url": "https://example.ilucca.net/lucca-api/employees/416"
      },
      "employment": {
        "id": "441",
        "type": "employment",
        "url": "https://example.ilucca.net/lucca-api/employments/441"
      },
      "jobPosition": {
        "id": "600",
        "type": "job-position",
        "url": "https://example.ilucca.net/lucca-api/job-positions/600"
      },
      "applicability": {
        "start": "2026-01-01",
        "end": null,
        "strictStart": "2027-03-01",
        "strictEnd": null
      },
      "value": {
        "id": "15",
        "type": "employee",
        "url": "https://example.ilucca.net/lucca-api/employees/15"
      },
      "createdAt": "2027-03-01T09:43:52.432Z",
      "lastUpdatedAt": "2027-03-01T09:43:52.432Z",
      "links": {}
    }
  ],
  "links": {
    "prev": null,
    "next": {
      "href": "https://example.ilucca.net/lucca-api/employee-attributes?limit=10&page=!4sKv"
    }
  },
  "embedded": {
    "employee-attribute-definition": {
      "givenName": {
        "id": "employee.givenName",
        "type": "employee-attribute-definition",
        "url": "https://lucca.ilucca.net/lucca-api/employee-attribute-definitions/employee.givenName",
        "name": "First Name",
        "multipleValueHandling": null,
        "taxonomy": null,
        "schema": {
          "$schema": "https://json-schema.org/draft/2020-12/schema",
          "title": "employee.given-name",
          "maxLength": 255,
          "minLength": 1,
          "type": "string",
          "description": "Name given at birth. In the U.S.A., the first name of a person. In French: \"prénom\". Leading and trailing spaces are automatically removed."
        },
        "propertyDescriptions": {},
        "t9n": {
          "name": {
            "fr-FR": "Prénom"
          }
        },
        "createdAt": "2000-01-01T00:00:00+00:00",
        "lastUpdatedAt": "2000-01-01T00:00:00+00:00",
        "isArchived": false,
        "lastArchivedAt": null
      }
    },
    "taxonomy-label": {}
  }
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "https://example.ilucca.net/lucca-api/leaves/1573",
  "errors": {
    "endsOn": [
      "Invalid period: StartsOn should be before EndsOn."
    ],
    "employeeId": [
      "The employeeId query parameter is required."
    ]
  },
  "extensions": {
    "traceId": "|78777424-49cc27e04281bbfc."
  }
}

{
  "type": "https://datatracker.ietf.org/doc/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Internal Server Error",
  "status": 500,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

GET

lucca-api

employee-attributes

List employee-attributes

curl --request GET \
  --url https://{host}/lucca-api/employee-attributes \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{host}/lucca-api/employee-attributes"

headers = {
    "Api-Version": "<api-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Api-Version': '<api-version>', Authorization: 'Bearer <token>'}
};

fetch('https://{host}/lucca-api/employee-attributes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/lucca-api/employee-attributes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Api-Version: <api-version>",
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/lucca-api/employee-attributes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Api-Version", "<api-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/lucca-api/employee-attributes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Api-Version"] = '<api-version>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "type": "employee-attributes",
  "url": "https://example.ilucca.net/lucca-api/employee-attributes?limit=10",
  "totalCount": 3489,
  "items": [
    {
      "id": "34879",
      "type": "employee-attribute",
      "url": "https://example.ilucca.net/lucca-api/employee-attribute/34879",
      "definition": {
        "id": "givenName",
        "type": "employee-attribute-definition",
        "url": "https://example.ilucca.net/lucca-api/employee-attribute-definitions/givenName"
      },
      "employee": {
        "id": "416",
        "type": "employee",
        "url": "https://example.ilucca.net/lucca-api/employees/416"
      },
      "applicability": null,
      "value": "John",
      "createdAt": "2014-04-12T09:43:52.432Z",
      "lastUpdatedAt": "2014-04-12T09:43:52.432Z",
      "links": {}
    },
    {
      "id": "34880",
      "type": "employee-attribute",
      "url": "https://example.ilucca.net/lucca-api/employee-attribute/34880",
      "definition": {
        "id": "jobPosition.manager",
        "type": "employee-attribute-definition",
        "url": "https://example.ilucca.net/lucca-api/employee-attribute-definitions/jobPosition.manager"
      },
      "employee": {
        "id": "416",
        "type": "employee",
        "url": "https://example.ilucca.net/lucca-api/employees/416"
      },
      "employment": {
        "id": "441",
        "type": "employment",
        "url": "https://example.ilucca.net/lucca-api/employments/441"
      },
      "jobPosition": {
        "id": "600",
        "type": "job-position",
        "url": "https://example.ilucca.net/lucca-api/job-positions/600"
      },
      "applicability": {
        "start": "2026-01-01",
        "end": null,
        "strictStart": "2027-03-01",
        "strictEnd": null
      },
      "value": {
        "id": "15",
        "type": "employee",
        "url": "https://example.ilucca.net/lucca-api/employees/15"
      },
      "createdAt": "2027-03-01T09:43:52.432Z",
      "lastUpdatedAt": "2027-03-01T09:43:52.432Z",
      "links": {}
    }
  ],
  "links": {
    "prev": null,
    "next": {
      "href": "https://example.ilucca.net/lucca-api/employee-attributes?limit=10&page=!4sKv"
    }
  },
  "embedded": {
    "employee-attribute-definition": {
      "givenName": {
        "id": "employee.givenName",
        "type": "employee-attribute-definition",
        "url": "https://lucca.ilucca.net/lucca-api/employee-attribute-definitions/employee.givenName",
        "name": "First Name",
        "multipleValueHandling": null,
        "taxonomy": null,
        "schema": {
          "$schema": "https://json-schema.org/draft/2020-12/schema",
          "title": "employee.given-name",
          "maxLength": 255,
          "minLength": 1,
          "type": "string",
          "description": "Name given at birth. In the U.S.A., the first name of a person. In French: \"prénom\". Leading and trailing spaces are automatically removed."
        },
        "propertyDescriptions": {},
        "t9n": {
          "name": {
            "fr-FR": "Prénom"
          }
        },
        "createdAt": "2000-01-01T00:00:00+00:00",
        "lastUpdatedAt": "2000-01-01T00:00:00+00:00",
        "isArchived": false,
        "lastArchivedAt": null
      }
    },
    "taxonomy-label": {}
  }
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "https://example.ilucca.net/lucca-api/leaves/1573",
  "errors": {
    "endsOn": [
      "Invalid period: StartsOn should be before EndsOn."
    ],
    "employeeId": [
      "The employeeId query parameter is required."
    ]
  },
  "extensions": {
    "traceId": "|78777424-49cc27e04281bbfc."
  }
}

{
  "type": "https://datatracker.ietf.org/doc/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Internal Server Error",
  "status": 500,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

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.

Access

OAuth 2.0 scopes

 employee-attributes.readonly

 employee-attributes.readwrite

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.

Query Parameters

string[]

Filter out employee-attributes on their IDs.

Maximum array length: 100

Minimum string length: 1

Example:

["123", "456"]

definition.id

string[]

Filter out employee-attributes on the id of their associated definition.

Maximum array length: 100

Minimum string length: 1

Example:

[
  "jobPosition.manager",
  "e_certifications",
  "employee.familyName"
]

employee.id

string[]

Filter out employee-attributes on the id of the employee they belong to.

Maximum array length: 100

Minimum string length: 1

Example:

["123", "456"]

applicability.asOf

string<date>

Only return employee-attributes whose applicability period includes the given date. An attribute is considered applicable when its applicability.start is on or before the date and its applicability.end is on or after the date. Null bounds are treated as open-ended.

applicability.strictAsOf

string<date>

Only return employee-attributes whose strict applicability period includes the given date. Same semantics as applicability.asOf, but on applicability.strictStart / applicability.strictEnd, which do not fill the gaps between consecutive resources. A date falling in a period without any contract therefore returns nothing.

value

string

Filter out employee-attributes on their value.

When the value is a JSON object, then supports sub-property filtering using dot notation (e.g. value.foo=bar).

-value

string

Filter out employee-attributes on their value, by exclusion ("not").

When the value is a JSON object, then supports sub-property filtering using dot notation (e.g. -value.foo=bar meaning "where value.foo is not equal to bar").

sort

enum<string>[]

Order results by instruction. Read more about sorting. Default: id.

Available options:

id,

-id,

createdAt,

-createdAt,

value,

-value,

definition.id,

-definition.id

lastUpdatedAt

string

Filter out employee-attributes on their lastUpdatedAt timestamp (range). ISO 8601 formatted date-time-offset-range string. Designed as a right-half-open interval: end is excluded [start, end).

Each bound must be written as yyyy-MM-ddTHH:mm:ss, with optional fractional seconds, followed by an offset (Z or ±hh:mm). Seconds are required. A timestamp read from a response payload can be reused as a bound as is, within a precision of 100 ns.

Examples:

2026-01-01T00:00:00Z--2027-01-01T00:00:00Z: from Jan. 1st 2026 until Dec. 31st 2026.
..--2026-06-01T00:00:00Z: until May 31st 2026 (included).
2026-05-26T00:00:00Z--..: from May 26th 2026.
2026-05-26T07:23:29.7977299+00:00--..: from May 26th 2026, 07:23:29.7977299 UTC.

Pattern:

^(?:\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|[+-](?:[01]\d|2[0-3]):[0-5]\d)|\.\.)--(?:\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|[+-](?:[01]\d|2[0-3]):[0-5]\d)|\.\.)$

Examples:

"2026-01-01T00:00:00Z--2027-01-01T00:00:00Z"

"..--2026-06-01T00:00:00Z"

"2026-05-26T00:00:00Z--.."

"2026-05-26T07:23:29.7977299+00:00--.."

page

string

Cursor of the page to retrieve: the page value of links.next.href or links.prev.href in a previous response. Cursors are opaque: don't build or modify them. An invalid cursor gets a 400 Bad Request. Read more about pagination.

limit

integer

default:25

Number of items per page. Defaults to 25. Maximum is 1,000. Read more about pagination.

Required range: 0 <= x <= 1000

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.

Response

A collection of employee-attribute resources.

type

string

Allowed value: "employee-attributes"

url

string<uri>

totalCount

integer<int64> | null

Total number of items across all pages that satisfy query parameters.

Required range: x >= 0

items

employee-attribute · object[]

Items of this paginated list. May be partial and/or stale representations.

Maximum array length: 1000

Show child attributes

links

Links · object | null

Links to related resources

Show child attributes

embedded

object | null

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

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

Show child attributes

Overview

Files

Organization

Employee Records

Time Management

Events & Webhooks

List employee-attributes

Authorizations

Headers

Query Parameters

Response