{
"openapi": "3.1.0",
"info": {
"title": "Lucca API reference",
"version": "2024-11-01",
"x-revision": "aff707062dd5",
"description": "Please refer to developers.luccasoftware.com.",
"contact": {
"name": "API Support",
"url": "https://www.luccasoftware.com",
"email": "no-reply@luccasoftware.com"
},
"license": {
"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0"
}
},
"servers": [
{
"url": "https://{host}",
"description": "Your Lucca account URL.",
"variables": {
"host": {
"default": "example.ilucca.net",
"description": "The URL of your dedicated Lucca account: `{account}.{env}.{region}`.\n\nAccount reflects your company name. Env indicates the environment. Region depends on your server location.\n\n**Please, use your test or sandbox environments (and not your production env.) for testing purposes.**\n\nEnvironments:\n- `ilucca`: production environment for customers.\n- `ilucca-test`: test environment for customers.\n- `ilucca-demo`: demo environment for prospects.\n\nRegions:\n- `.ch` for Swiss located accounts.\n- `.net` for the others.\n\nRegarding sandboxes, the pattern differs: `https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com`, where:\n- `{sandboxName}` is automatically generated upon creation.\n- `{server}` may be \"eu1\", \"eu2\" or \"ch1\"."
}
}
}
],
"tags": [
{
"name": "organization",
"description": "Organization."
},
{
"name": "employees",
"description": "Employees."
},
{
"name": "employments",
"description": "Employments & job-positions."
},
{
"name": "employee-occupation-categories",
"description": "Employee occupations categories."
},
{
"name": "employee-job-qualifications",
"description": "Job qualifications & professions."
},
{
"name": "employee-attributes",
"description": "Employee-Attributes."
},
{
"name": "taxonomies",
"description": "Taxonomies & taxonomy-labels."
},
{
"name": "webhooks",
"description": "Webhooks."
},
{
"name": "events",
"description": "Major resources of the Lucca API are subject to events, which means every time\ntheir state changes (creation, update, deletion), an event is fired.\n\nThese events are stored for a limited time (c.f. documentation), and can either be retrieved through the\nevents endpoint, or they can be sent to your webhook-endpoint."
},
{
"name": "working-time-arrangements",
"description": "working-time-arrangements"
},
{
"name": "files",
"description": "Files management."
}
],
"paths": {
"/lucca-api/files": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"post": {
"x-beta": true,
"operationId": "post-files",
"summary": "Upload a file",
"description": "Upload a file in order to reference it as the attachment of another resource (e.g. a portrait).",
"tags": [
"files"
],
"security": [
{
"oAuth": [
"files.readwrite"
]
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"form": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"responses": {
"201": {
"description": "File successfully uploaded.",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"Location": {
"$ref": "#/components/headers/location"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"allOf": [
{
"$ref": "#/components/schemas/file.read"
}
]
},
"examples": {
"file": {
"$ref": "#/components/examples/file.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/files/post-files",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n files.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Upload a file"
}
}
}
},
"/lucca-api/files/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
},
{
"name": "id",
"description": "Unique id of the file.",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"get": {
"x-beta": true,
"operationId": "get-file",
"tags": [
"files"
],
"summary": "Retrieve a file",
"description": "Retrieve a file, either its JSON representation or its content.",
"security": [
{
"oAuth": [
"files.readonly"
]
},
{
"oAuth": [
"files.readwrite"
]
}
],
"parameters": [
{
"name": "token",
"description": "The token allowing to access the file, required in addition to the access token: the access token lets you use the files API, and this token, minted by the service that owns the file, lets you view this file.\nThis token can only be obtained via the API resource that references this file, read with `?include=links`: `links.files[\"{id}\"].token` (e.g. on an employee-attribute, an employment, a job-position or an employee).\nIt is bound to the API client that read the resource, and expires after `links.files[\"{id}\"].expiresAt`. The deprecated `links.document` and `links.portrait` links also carry one, whose expiry is not exposed.",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
},
{
"name": "Accept",
"description": "The **Accept** response header indicates the content type of the response.\n\n- `Accept: application/octet-stream` returns the raw file content.\n- `Accept: image/*` returns a preview of the file (when possible).\n- If Accept matches exactly `file.contentType`, returns the raw file content.\n- `Accept: application/json` or `Accept: */*` or no Accept header (default) returns the file metadata in JSON format.",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "disposition",
"description": "Specifies how the file should be handled by the client.\n\nSupersedes the `Accept` header when possible. To be used whenever the API client cannot set custom `Accept` headers.\n\n- `json` (default) returns the file metadata in JSON format.\n- `inline` returns the file content to be displayed inline in the browser (when possible).\n- `attachment` returns the file content as a download.",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"json",
"inline",
"attachment"
]
}
}
],
"responses": {
"200": {
"description": "Representation of the requested file, either its JSON representation or its content.",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"allOf": [
{
"$ref": "#/components/schemas/file.read"
}
]
},
"examples": {
"file": {
"$ref": "#/components/examples/file.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401",
"description": "You are not authenticated: the `Authorization` header is missing, or the access token is invalid or expired.\nThe `token` query parameter does not authenticate you on its own."
},
"403": {
"$ref": "#/components/responses/403",
"description": "You may not access this file: your access token lacks the `files.readonly` or `files.readwrite` scope, or the\n`token` query parameter is missing, expired, or was minted for another API client."
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/files/get-file",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n files.readonly\n```\nor \n```\n files.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Retrieve a file"
}
}
}
},
"/lucca-api/legal-entities": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"get": {
"operationId": "get-legal-entities",
"tags": [
"organization"
],
"summary": "List legal-entities",
"description": "Returns a paginated list of legal-entities.",
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Filter out legal-entities on the country they belong to.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/country-code"
},
"examples": [
[
"FRA",
"DEU",
"ESP"
]
]
}
},
{
"$ref": "#/components/parameters/is-archived"
},
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit"
}
],
"security": [
{
"oAuth": [
"legal-entities.readonly"
]
},
{
"oAuth": [
"legal-entities.readwrite"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"allOf": [
{
"$ref": "#/components/schemas/legal-entities.read"
}
]
},
"examples": {
"legal-entities": {
"$ref": "#/components/examples/legal-entities.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/organization/get-legal-entities",
"content": "\n**OAuth 2.0 scopes**\n\n```\n legal-entities.readonly\n```\nor \n```\n legal-entities.readwrite\n```\n",
"metadata": {
"sidebarTitle": "List legal-entities"
}
}
}
},
"/lucca-api/legal-entities/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
},
{
"name": "id",
"description": "Unique id of the legal-entity.",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"get": {
"operationId": "get-legal-entity",
"tags": [
"organization"
],
"summary": "Retrieve a legal-entity",
"description": "Retrieve a legal-entity.",
"security": [
{
"oAuth": [
"legal-entities.readonly"
]
},
{
"oAuth": [
"legal-entities.readwrite"
]
}
],
"responses": {
"200": {
"description": "Representation of the requested legal-entity.",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A legal-entity resource.",
"allOf": [
{
"$ref": "#/components/schemas/legal-entity.read"
}
]
},
"examples": {
"legal-entity": {
"$ref": "#/components/examples/legal-entity.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/organization/get-legal-entity",
"content": "\n**OAuth 2.0 scopes**\n\n```\n legal-entities.readonly\n```\nor \n```\n legal-entities.readwrite\n```\n",
"metadata": {
"sidebarTitle": "Retrieve a legal-entity"
}
}
}
},
"/lucca-api/business-establishments": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"get": {
"operationId": "list-business-establishments",
"tags": [
"organization"
],
"summary": "List business-establishments",
"description": "List business-establishments.",
"parameters": [
{
"name": "legalEntity.id",
"description": "Only return business-establishments belonging to one of the given legal-entity id.",
"in": "query",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"example": [
"1",
"3"
]
}
},
{
"name": "search",
"description": "Filter business-establishments by their name and/or remoteId. The search is case insensitive and looks for partial matches.",
"in": "query",
"schema": {
"type": "string",
"minLength": 1
}
},
{
"$ref": "#/components/parameters/is-archived"
},
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit"
}
],
"security": [
{
"oAuth": [
"business-establishments.readonly"
]
},
{
"oAuth": [
"business-establishments.readwrite"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A collection of business-establishment resources.",
"allOf": [
{
"$ref": "#/components/schemas/business-establishments.read"
}
]
},
"examples": {
"business-establishments": {
"$ref": "#/components/examples/business-establishments.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/organization/list-business-establishments",
"content": "\n**OAuth 2.0 scopes**\n\n```\n business-establishments.readonly\n```\nor \n```\n business-establishments.readwrite\n```\n",
"metadata": {
"sidebarTitle": "List business-establishments"
}
}
}
},
"/lucca-api/business-establishments/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
},
{
"name": "id",
"description": "Unique id of the business-establishment.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"operationId": "get-business-establishment",
"tags": [
"organization"
],
"summary": "Retrieve a business-establishment",
"description": "Retrieve a business-establishment.",
"security": [
{
"oAuth": [
"business-establishments.readonly"
]
},
{
"oAuth": [
"business-establishments.readwrite"
]
}
],
"responses": {
"200": {
"description": "Representation of the requested business-establishment.",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A business-establishment resource.",
"allOf": [
{
"$ref": "#/components/schemas/business-establishment.read"
}
]
},
"examples": {
"business-establishment": {
"$ref": "#/components/examples/business-establishment.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/organization/get-business-establishment",
"content": "\n**OAuth 2.0 scopes**\n\n```\n business-establishments.readonly\n```\nor \n```\n business-establishments.readwrite\n```\n",
"metadata": {
"sidebarTitle": "Retrieve a business-establishment"
}
}
}
},
"/lucca-api/departments": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"get": {
"operationId": "get-departments",
"tags": [
"organization"
],
"summary": "List departments",
"description": "Returns a paginated list of departments.",
"parameters": [
{
"name": "search",
"description": "Filter departments by their name and/or remoteId. The search is case insensitive and looks for partial matches.",
"in": "query",
"schema": {
"type": "string",
"minLength": 1
}
},
{
"name": "sort",
"description": "Sort departments. Can be chained. Default is `id`, i.e. \"id ascending\".",
"in": "query",
"schema": {
"type": "string",
"enum": [
"id",
"+id",
"-id",
"name",
"+name",
"-name"
],
"default": "id"
}
},
{
"$ref": "#/components/parameters/is-archived"
},
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit"
}
],
"security": [
{
"oAuth": [
"departments.readonly"
]
},
{
"oAuth": [
"departments.readwrite"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A collection of [department](/api-reference/2024-11-01/organization/department) resources.",
"allOf": [
{
"$ref": "#/components/schemas/departments.read"
}
]
},
"examples": {
"departments": {
"$ref": "#/components/examples/departments.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/organization/get-departments",
"content": "\n**OAuth 2.0 scopes**\n\n```\n departments.readonly\n```\nor \n```\n departments.readwrite\n```\n",
"metadata": {
"sidebarTitle": "List departments"
}
}
},
"post": {
"operationId": "post-departments",
"tags": [
"organization"
],
"summary": "Create a department",
"description": "Create a new department.",
"security": [
{
"oAuth": [
"departments.readwrite"
]
}
],
"requestBody": {
"description": "Representation of a [department](/api-reference/2024-11-01/organization/department).",
"content": {
"application/json": {
"schema": {
"description": "The department to create.",
"allOf": [
{
"$ref": "#/components/schemas/department.create"
}
]
},
"examples": {
"department": {
"$ref": "#/components/examples/departments.post.example"
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"Location": {
"$ref": "#/components/headers/location"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"description": "The created department resource.",
"allOf": [
{
"$ref": "#/components/schemas/department.read"
}
]
},
"examples": {
"department": {
"$ref": "#/components/examples/department.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/organization/post-departments",
"content": "\n**OAuth 2.0 scopes**\n\n```\n departments.readwrite\n```\n",
"metadata": {
"sidebarTitle": "Create a department"
}
}
}
},
"/lucca-api/departments/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
},
{
"name": "id",
"description": "Identifier of the department to retrieve.",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"get": {
"operationId": "get-department",
"tags": [
"organization"
],
"summary": "Retrieve a department",
"description": "Retrieve a single department by ID.",
"security": [
{
"oAuth": [
"departments.readonly"
]
},
{
"oAuth": [
"departments.readwrite"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A [department](/api-reference/2024-11-01/organization/department) resource.",
"allOf": [
{
"$ref": "#/components/schemas/department.read"
}
]
},
"examples": {
"department": {
"$ref": "#/components/examples/department.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/organization/get-department",
"content": "\n**OAuth 2.0 scopes**\n\n```\n departments.readonly\n```\nor \n```\n departments.readwrite\n```\n",
"metadata": {
"sidebarTitle": "Retrieve a department"
}
}
},
"patch": {
"operationId": "patch-department",
"tags": [
"organization"
],
"summary": "Update a department",
"description": "Update a department.",
"security": [
{
"oAuth": [
"departments.readwrite"
]
}
],
"requestBody": {
"description": "Representation of a [department](/api-reference/2024-11-01/organization/department).",
"content": {
"application/json": {
"schema": {
"description": "The representation of the department to update.",
"allOf": [
{
"$ref": "#/components/schemas/department.update"
}
]
},
"examples": {
"department": {
"$ref": "#/components/examples/department.patch.example"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The updated department resource.",
"allOf": [
{
"$ref": "#/components/schemas/department.read"
}
]
},
"examples": {
"department": {
"$ref": "#/components/examples/department.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/organization/patch-department",
"content": "\n**OAuth 2.0 scopes**\n\n```\n departments.readwrite\n```\n",
"metadata": {
"sidebarTitle": "Update a department"
}
}
}
},
"/lucca-api/professions": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"get": {
"x-beta": true,
"operationId": "get-professions",
"tags": [
"employee-job-qualifications"
],
"summary": "List professions",
"description": "List professions.",
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/is-archived"
}
],
"security": [
{
"oAuth": [
"job-qualifications.readonly"
]
},
{
"oAuth": [
"job-qualifications.readwrite"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A collection of profession resources.",
"allOf": [
{
"$ref": "#/components/schemas/professions.read"
}
]
},
"examples": {
"professions": {
"$ref": "#/components/examples/professions.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/employee-job-qualifications/get-professions",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n job-qualifications.readonly\n```\nor \n```\n job-qualifications.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "List professions"
}
}
}
},
"/lucca-api/professions/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
},
{
"name": "id",
"description": "Identifier of the profession to retrieve.",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"get": {
"x-beta": true,
"operationId": "get-profession",
"summary": "Retrieve a profession",
"description": "Retrieve a profession by its ID.",
"tags": [
"employee-job-qualifications"
],
"security": [
{
"oAuth": [
"job-qualifications.readonly"
]
},
{
"oAuth": [
"job-qualifications.readwrite"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A profession resource.",
"allOf": [
{
"$ref": "#/components/schemas/profession.read"
}
]
},
"examples": {
"profession": {
"$ref": "#/components/examples/profession.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/employee-job-qualifications/get-profession",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n job-qualifications.readonly\n```\nor \n```\n job-qualifications.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Retrieve a profession"
}
}
}
},
"/lucca-api/occupation-categories": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"get": {
"x-beta": true,
"operationId": "get-occupation-categories",
"tags": [
"employee-occupation-categories"
],
"summary": "List occupation-categories",
"description": "Returns a paginated list of occupation-categories.",
"parameters": [
{
"name": "businessEstablishments.id",
"description": "Only return occupation-categories belonging to at least one of the given\nbusiness-establishment IDs.\n\nNote: occupation-categories with a `null` relationship with business-establishments\nmust be considered belonging to ALL of them. As a result, you may retrieve such\noccupation-categories when filtering them out on their business-establishment IDs.",
"in": "query",
"required": false,
"explode": false,
"style": "form",
"schema": {
"type": "array",
"maxItems": 100,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1
},
"example": [
"1",
"3"
]
}
},
{
"name": "search",
"description": "Filter occupation-categories by their title. The search is case insensitive and looks for partial matches.",
"in": "query",
"schema": {
"type": "string",
"minLength": 1
}
},
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit"
}
],
"security": [
{
"oAuth": [
"occupation-categories.readonly"
]
},
{
"oAuth": [
"occupation-categories.readwrite"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A collection of occupation-category resources.",
"allOf": [
{
"$ref": "#/components/schemas/occupation-categories.read"
}
]
},
"examples": {
"occupation": {
"$ref": "#/components/examples/occupation-categories.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/employee-occupation-categories/get-occupation-categories",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n occupation-categories.readonly\n```\nor \n```\n occupation-categories.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "List occupation-categories"
}
}
}
},
"/lucca-api/occupation-categories/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
},
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier of the occupation-category",
"schema": {
"type": "string",
"minLength": 1
}
}
],
"get": {
"x-beta": true,
"operationId": "get-occupation-category",
"tags": [
"employee-occupation-categories"
],
"summary": "Retrieve an occupation-category",
"description": "Retrieve an occupation-category.",
"security": [
{
"oAuth": [
"occupation-categories.readonly"
]
},
{
"oAuth": [
"occupation-categories.readwrite"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "An occupation-category resource.",
"allOf": [
{
"$ref": "#/components/schemas/occupation-category.read"
}
]
},
"examples": {
"occupation": {
"$ref": "#/components/examples/occupation-category.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/employee-occupation-categories/get-occupation-category",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n occupation-categories.readonly\n```\nor \n```\n occupation-categories.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Retrieve an occupation-category"
}
}
}
},
"/lucca-api/job-qualifications": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"get": {
"x-beta": true,
"operationId": "get-job-qualifications",
"tags": [
"employee-job-qualifications"
],
"summary": "List job-qualifications",
"description": "Returns a paginated list of job-qualifications.\n\nResults are ordered by `id` by default; use the `sort` parameter to change the ordering.",
"parameters": [
{
"name": "rank",
"description": "Filter out job-qualifications on their rank",
"in": "query",
"required": false,
"explode": false,
"style": "form",
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "integer",
"minimum": 0
}
},
"example": [
0,
1
]
},
{
"name": "profession.id",
"description": "Filter out job-qualifications on their profession's IDs.",
"in": "query",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1
}
},
"example": [
"12",
"23"
]
},
{
"name": "search",
"description": "Filter job-qualifications by their title. The search is case insensitive, accent insensitive and looks for partial matches.",
"in": "query",
"required": false,
"schema": {
"type": "string",
"minLength": 1
}
},
{
"name": "sort",
"description": "Sort the results. Supported keys: `id`, `name` (job-qualification title), `rank`, `profession` (profession name).\nPrefix a key with `+` (ascending, the default) or `-` (descending), and combine keys with commas — e.g. `sort=profession,rank`.\nDefaults to `id`.",
"in": "query",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"id",
"+id",
"-id",
"name",
"+name",
"-name",
"rank",
"+rank",
"-rank",
"profession",
"+profession",
"-profession"
]
}
},
"example": [
"profession",
"rank"
]
},
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit"
}
],
"security": [
{
"oAuth": [
"job-qualifications.readonly"
]
},
{
"oAuth": [
"job-qualifications.readwrite"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A collection of job-qualification resources.",
"allOf": [
{
"$ref": "#/components/schemas/job-qualifications.read"
}
]
},
"examples": {
"job-qualifications": {
"$ref": "#/components/examples/job-qualifications.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/employee-job-qualifications/get-job-qualifications",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n job-qualifications.readonly\n```\nor \n```\n job-qualifications.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "List job-qualifications"
}
}
}
},
"/lucca-api/job-qualifications/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
},
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier of the job-qualification",
"schema": {
"type": "string",
"minLength": 1
}
}
],
"get": {
"x-beta": true,
"operationId": "get-job-qualification",
"summary": "Retrieve a job-qualification",
"description": "Retrieve a job-qualification by its ID.",
"tags": [
"employee-job-qualifications"
],
"security": [
{
"oAuth": [
"job-qualifications.readonly"
]
},
{
"oAuth": [
"job-qualifications.readwrite"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A job-qualification resource.",
"allOf": [
{
"$ref": "#/components/schemas/job-qualification.read"
}
]
},
"examples": {
"job-qualification": {
"$ref": "#/components/examples/job-qualification.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/employee-job-qualifications/get-job-qualification",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n job-qualifications.readonly\n```\nor \n```\n job-qualifications.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Retrieve a job-qualification"
}
}
}
},
"/lucca-api/employees": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"get": {
"x-beta": true,
"operationId": "get-employees",
"tags": [
"employees"
],
"summary": "List employees",
"description": "Returns a paginated list of employees.",
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit1000"
},
{
"name": "search",
"description": "Find an employee by their name. The employee given or family names must start with the given words. Each word can be delimited with any of these delimiters: `[' ', '-', '_', ',', '.']`.",
"in": "query",
"schema": {
"type": "string",
"minLength": 1
}
},
{
"name": "id",
"in": "query",
"description": "Filter out employees on their ID.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"maxItems": 100,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"123",
"456"
]
]
}
},
{
"name": "email",
"in": "query",
"description": "Filter out employees on their email address (strict equality). Comma-separated list. Send \"?email=null\" to retrieve employees with no email address.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"maxItems": 100,
"uniqueItems": true,
"items": {
"oneOf": [
{
"title": "by email",
"type": "string",
"format": "idn-email",
"minLength": 3,
"maxLength": 255
},
{
"title": "with no email",
"type": "string",
"const": "null"
}
]
}
}
},
{
"name": "status",
"in": "query",
"description": "Filter out employees on their status.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"maxItems": 100,
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/employee-status"
},
"examples": [
[
"active"
]
]
}
},
{
"name": "applicableEmployment.legalEntity.id",
"in": "query",
"description": "Filter out employees on their active employment legal-entity IDs.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"maxItems": 100,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"12",
"13"
]
]
}
},
{
"name": "applicableEmployment.remoteId",
"in": "query",
"description": "Filter out employees on their active employment remoteId.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"maxItems": 100,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"E001",
"E023"
]
]
}
},
{
"name": "applicableEmployment.startsOn",
"in": "query",
"description": "Filter out employees on their active employment startsOn date (strict equality).",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "applicableEmployment.startsOn.between",
"in": "query",
"description": "Filter out employees on their active employment startsOn date.\n[ISO 8601 formatted date-range](/documentation/using-api/filtering#dates-date-times-and-date-time-offsets) string.",
"schema": {
"$ref": "#/components/schemas/daterange"
}
},
{
"name": "applicableEmployment.endsOn",
"in": "query",
"description": "Filter out employees on their applicable employment endsOn date (strict equality).",
"schema": {
"oneOf": [
{
"title": "date",
"type": "string",
"format": "date"
},
{
"title": "null",
"type": "string",
"const": "null"
}
]
}
},
{
"name": "applicableEmployment.endsOn.between",
"in": "query",
"description": "Filter out employees on their applicable employment endsOn date.\n[ISO 8601 formatted date-range](/documentation/using-api/filtering#dates-date-times-and-date-time-offsets) string.",
"schema": {
"$ref": "#/components/schemas/daterange"
}
},
{
"name": "applicableEmployment.template.id",
"in": "query",
"style": "form",
"explode": false,
"description": "Filter out employees on their applicable employment template IDs.",
"schema": {
"type": "array",
"maxItems": 100,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"1",
"2",
"5"
]
]
}
},
{
"name": "applicableEmployment.template.term",
"in": "query",
"style": "form",
"explode": false,
"description": "Filter out employees on their applicable employment template term.",
"schema": {
"type": "array",
"maxItems": 100,
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/employment-term"
},
"examples": [
[
"permanent"
]
]
}
},
{
"name": "applicableJobPosition.remoteId",
"in": "query",
"description": "Filter out employees on their applicable job-position remoteId.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"maxItems": 100,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"null",
"JP001",
"JP002"
]
]
}
},
{
"name": "applicableJobPosition.businessEstablishment.id",
"in": "query",
"description": "Filter out employees on their active job-position business-establishment IDs.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"maxItems": 100,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"12",
"13"
]
]
}
},
{
"name": "applicableJobPosition.department.id",
"in": "query",
"description": "Filter out employees on their applicable job-position department IDs.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"maxItems": 100,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"123",
"452"
]
]
}
},
{
"name": "applicableJobPosition.manager.id",
"in": "query",
"description": "Filter out employees on their manager's IDs.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"maxItems": 100,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"416",
"521"
]
]
}
},
{
"name": "applicableJobPosition.jobQualification.id",
"in": "query",
"description": "Filter out employees on their applicable job-position job-qualification IDs.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"maxItems": 100,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"25",
"28"
]
]
}
},
{
"name": "applicableJobPosition.jobQualification.remoteId",
"in": "query",
"description": "Filter out employees on their active job-position job-qualification remoteId.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"maxItems": 100,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"null",
"JQ001",
"JQ002"
]
]
}
},
{
"name": "applicableJobPosition.occupationCategory.id",
"in": "query",
"description": "Filter out employees on their active job-position occupation-category IDs.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"maxItems": 100,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"5",
"12"
]
]
}
},
{
"name": "applicableJobPosition.occupationCategory.remoteId",
"in": "query",
"description": "Filter out employees on their active job-position occupation-category remoteId.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"maxItems": 100,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"null",
"OC001",
"OC002"
]
]
}
},
{
"name": "sort",
"in": "query",
"description": "Order employees by given instruction. [Read more about sorting](/documentation/using-api/sorting). Default: `id`.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"default": [
"id"
],
"maxItems": 100,
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"id",
"-id",
"familyName",
"-familyName",
"createdAt",
"-createdAt"
]
}
}
},
{
"name": "lastUpdatedAt",
"in": "query",
"description": "Filter out employees on their `lastUpdatedAt` timestamp (range).",
"schema": {
"$ref": "#/components/schemas/datetimeoffsetrange"
}
}
],
"security": [
{
"oAuth": [
"employees.readonly"
]
},
{
"oAuth": [
"employees.readwrite"
]
}
],
"x-mint": {
"oauth": {
"establishments": "You may only access employees whose applicable business-establishments are accessible to you."
},
"href": "/api-reference/latest/employees/get-employees",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employees.readonly\n```\nor \n```\n employees.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access employees whose applicable business-establishments are accessible to you.**\n\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "List employees"
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A collection of employee resources.",
"allOf": [
{
"$ref": "#/components/schemas/employees.read"
}
]
},
"examples": {
"employees": {
"$ref": "#/components/examples/employees.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
}
},
"post": {
"x-beta": true,
"operationId": "post-employees",
"tags": [
"employees"
],
"summary": "Create an employee",
"description": "When creating an employee, you MUST also indicate their first employment,\nas an employee must belong to a [legal-entity](/api-reference/2024-11-01/organization/legal-entity)\nat all time.\n\nYou MUST also create the first [job-position](/api-reference/2024-11-01/employments/job-position) this\nemployee will occupy over their first [employment](/api-reference/2024-11-01/employments/employment).\n\nNote: these first employment and job-position will then be considered their applicable \nones in the API response.",
"security": [
{
"oAuth": [
"employees.readwrite",
"employments.readwrite",
"job-positions.readwrite"
]
}
],
"x-mint": {
"oauth": {
"establishments": "You may only access employees whose applicable business-establishments are accessible to you."
},
"href": "/api-reference/latest/employees/post-employees",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employees.readwrite employments.readwrite job-positions.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access employees whose applicable business-establishments are accessible to you.**\n\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Create an employee"
}
},
"requestBody": {
"description": "The employee to create.",
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "Representation of an employee with their applicable employment as well as job-position.",
"allOf": [
{
"$ref": "#/components/schemas/employee.create"
}
]
},
"examples": {
"edward": {
"$ref": "#/components/examples/employees.post.example"
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"Location": {
"$ref": "#/components/headers/location"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The created employee resource.",
"allOf": [
{
"$ref": "#/components/schemas/employee.read"
}
]
},
"examples": {
"edward": {
"$ref": "#/components/examples/employee.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"default": {
"$ref": "#/components/responses/500"
}
}
}
},
"/lucca-api/employees/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
},
{
"name": "id",
"description": "Identifier of the employee to retrieve.",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"get": {
"x-beta": true,
"operationId": "get-employee",
"tags": [
"employees"
],
"summary": "Retrieve an employee",
"description": "Retrieve a single employee.",
"security": [
{
"oAuth": [
"employees.readonly"
]
},
{
"oAuth": [
"employees.readwrite"
]
}
],
"x-mint": {
"oauth": {
"establishments": "You may only access employees whose applicable business-establishments are accessible to you."
},
"href": "/api-reference/latest/employees/get-employee",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employees.readonly\n```\nor \n```\n employees.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access employees whose applicable business-establishments are accessible to you.**\n\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Retrieve an employee"
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "An employee resource.",
"allOf": [
{
"$ref": "#/components/schemas/employee.read"
}
]
},
"examples": {
"edward": {
"$ref": "#/components/examples/employee.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
}
},
"patch": {
"x-beta": true,
"operationId": "patch-employee",
"tags": [
"employees"
],
"summary": "Update an employee",
"description": "Update an employee.",
"security": [
{
"oAuth": [
"employees.readwrite"
]
}
],
"x-mint": {
"oauth": {
"establishments": "You may only access employees whose applicable business-establishments are accessible to you."
},
"href": "/api-reference/latest/employees/patch-employee",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employees.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access employees whose applicable business-establishments are accessible to you.**\n\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Update an employee"
}
},
"requestBody": {
"description": "Representation of an [employee](/api-reference/2024-11-01/employees/employee).",
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The (partial) representation of the employee to update.",
"allOf": [
{
"$ref": "#/components/schemas/employee.update"
}
]
},
"examples": {
"edward": {
"$ref": "#/components/examples/employee.patch.example"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The updated employee resource.",
"allOf": [
{
"$ref": "#/components/schemas/employee.read"
}
]
},
"examples": {
"edward": {
"$ref": "#/components/examples/employee.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
}
}
},
"/lucca-api/employee-attribute-definitions": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"get": {
"x-beta": true,
"operationId": "get-employee-attribute-definitions",
"tags": [
"employee-attributes"
],
"summary": "List employee-attribute-definitions",
"description": "Returns a paginated list of employee-attribute-definitions.",
"parameters": [
{
"name": "id",
"in": "query",
"description": "Filter out employee-attribute-definitions on their IDs.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"jobPosition.manager",
"e_certifications",
"employee.familyName"
]
]
}
},
{
"$ref": "#/components/parameters/schema.title"
},
{
"name": "search",
"in": "query",
"description": "Find an employee-attribute-definition by its name. The name must start with the given value.",
"schema": {
"type": "string",
"minLength": 1
}
},
{
"name": "category",
"in": "query",
"description": "Filter employee-attribute-definitions by the API surface exposing their values: `system` for properties of a primary resource, `extension` for values only readable on `employee-attributes`.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 2,
"items": {
"type": "string",
"enum": [
"system",
"extension"
]
},
"examples": [
[
"extension"
]
]
}
},
{
"$ref": "#/components/parameters/is-archived"
},
{
"name": "sort",
"in": "query",
"description": "Order results by instruction. [Read more about sorting](/documentation/using-api/sorting). Default: `id`.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"default": [
"id"
],
"items": {
"type": "string",
"enum": [
"id",
"-id",
"name",
"-name",
"createdAt",
"-createdAt"
]
}
}
},
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit1000"
}
],
"security": [
{
"oAuth": [
"employee-attribute-definitions.readonly"
]
},
{
"oAuth": [
"employee-attribute-definitions.readwrite"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A collection of [employee-attribute-definition](/api-reference/2024-11-01/employee-attributes/employee-attribute-definition) resources.",
"allOf": [
{
"$ref": "#/components/schemas/employee-attribute-definitions.read"
}
]
},
"examples": {
"definitions": {
"$ref": "#/components/examples/employee-attribute-definitions.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/employee-attributes/get-employee-attribute-definitions",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employee-attribute-definitions.readonly\n```\nor \n```\n employee-attribute-definitions.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "List employee-attribute-definitions"
}
}
},
"post": {
"x-beta": true,
"operationId": "post-employee-attribute-definition",
"tags": [
"employee-attributes"
],
"summary": "Create an employee-attribute-definition",
"description": "Create a new employee-attribute-definition.\n\nCreated definitions always target `employee` (`targetType`).\n\nExample request body, with a `schema` referencing a Lucca base schema:\n\n```json\n{\n \"id\": \"e_tShirtSize\",\n \"name\": \"T-shirt size\",\n \"multipleValueHandling\": null,\n \"schema\": { \"$ref\": \"/lucca-api/schemas/taxonomy-label-reference\" },\n \"taxonomy\": { \"id\": \"45\" },\n \"t9n\": { \"name\": { \"fr-FR\": \"Taille de t-shirt\" } }\n}\n```",
"security": [
{
"oAuth": [
"employee-attribute-definitions.readwrite"
]
}
],
"requestBody": {
"description": "The employee-attribute-definition to create.",
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The employee-attribute-definition to create.",
"allOf": [
{
"$ref": "#/components/schemas/employee-attribute-definition.create"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"Location": {
"$ref": "#/components/headers/location"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The created employee-attribute-definition resource.",
"allOf": [
{
"$ref": "#/components/schemas/employee-attribute-definition.read"
}
]
},
"examples": {
"definition": {
"$ref": "#/components/examples/employee-attribute-definition.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/employee-attributes/post-employee-attribute-definition",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employee-attribute-definitions.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Create an employee-attribute-definition"
}
}
}
},
"/lucca-api/employee-attribute-definitions/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
},
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier of the employee-attribute-definition.",
"schema": {
"type": "string",
"minLength": 1
}
}
],
"get": {
"x-beta": true,
"operationId": "get-employee-attribute-definition",
"tags": [
"employee-attributes"
],
"summary": "Retrieve an employee-attribute-definition",
"description": "Retrieve a single employee-attribute-definition by ID.",
"security": [
{
"oAuth": [
"employee-attribute-definitions.readonly"
]
},
{
"oAuth": [
"employee-attribute-definitions.readwrite"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "An [employee-attribute-definition](/api-reference/2024-11-01/employee-attributes/employee-attribute-definition) resource.",
"allOf": [
{
"$ref": "#/components/schemas/employee-attribute-definition.read"
}
]
},
"examples": {
"definition": {
"$ref": "#/components/examples/employee-attribute-definition.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/employee-attributes/get-employee-attribute-definition",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employee-attribute-definitions.readonly\n```\nor \n```\n employee-attribute-definitions.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Retrieve an employee-attribute-definition"
}
}
},
"put": {
"x-beta": true,
"operationId": "put-employee-attribute-definition",
"tags": [
"employee-attributes"
],
"summary": "Replace an employee-attribute-definition",
"description": "Replace an employee-attribute-definition.\n\nOnly the extensions created by your organization can be updated: any other definition returns a `400` with the `attribute-definition-not-editable` error. The base schema of `schema` cannot change.\n\nUnlike `PATCH`, the request body replaces the whole definition: an omitted `isArchived` unarchives it, an omitted `multipleValueHandling` makes it single-valued, and omitted translations are removed.\n\nExample request body, with a `schema` referencing a Lucca base schema:\n\n```json\n{\n \"name\": \"T-shirt size\",\n \"multipleValueHandling\": null,\n \"schema\": { \"$ref\": \"/lucca-api/schemas/taxonomy-label-reference\" },\n \"isArchived\": false,\n \"t9n\": { \"name\": { \"fr-FR\": \"Taille de t-shirt\" } }\n}\n```",
"security": [
{
"oAuth": [
"employee-attribute-definitions.readwrite"
]
}
],
"requestBody": {
"description": "Representation of an [employee-attribute-definition](/api-reference/2024-11-01/employee-attributes/employee-attribute-definition).",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "The full representation of the employee-attribute-definition.",
"required": [
"name",
"schema"
],
"allOf": [
{
"$ref": "#/components/schemas/employee-attribute-definition.update"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The updated employee-attribute-definition resource.",
"allOf": [
{
"$ref": "#/components/schemas/employee-attribute-definition.read"
}
]
},
"examples": {
"definition": {
"$ref": "#/components/examples/employee-attribute-definition.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/employee-attributes/put-employee-attribute-definition",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employee-attribute-definitions.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Replace an employee-attribute-definition"
}
}
},
"patch": {
"x-beta": true,
"operationId": "patch-employee-attribute-definition",
"tags": [
"employee-attributes"
],
"summary": "Update an employee-attribute-definition",
"description": "Update an employee-attribute-definition.\n\nOnly the extensions created by your organization can be updated: any other definition returns a `400` with the `attribute-definition-not-editable` error. The base schema of `schema` cannot change.",
"security": [
{
"oAuth": [
"employee-attribute-definitions.readwrite"
]
}
],
"requestBody": {
"description": "Representation of an [employee-attribute-definition](/api-reference/2024-11-01/employee-attributes/employee-attribute-definition).",
"content": {
"application/json": {
"schema": {
"description": "The representation of the employee-attribute-definition to update.",
"allOf": [
{
"$ref": "#/components/schemas/employee-attribute-definition.update"
}
]
},
"examples": {
"definition": {
"$ref": "#/components/examples/employee-attribute-definition.patch.example"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The updated employee-attribute-definition resource.",
"allOf": [
{
"$ref": "#/components/schemas/employee-attribute-definition.read"
}
]
},
"examples": {
"definition": {
"$ref": "#/components/examples/employee-attribute-definition.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/employee-attributes/patch-employee-attribute-definition",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employee-attribute-definitions.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Update an employee-attribute-definition"
}
}
},
"delete": {
"x-beta": true,
"operationId": "delete-employee-attribute-definition",
"tags": [
"employee-attributes"
],
"summary": "Delete an employee-attribute-definition",
"description": "Archive an employee-attribute-definition by ID.\n\nThe definition is not deleted: it remains readable with `isArchived: true`. Only the extensions created by your organization can be archived: any other definition returns a `404`.",
"security": [
{
"oAuth": [
"employee-attribute-definitions.readwrite"
]
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/employee-attributes/delete-employee-attribute-definition",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employee-attribute-definitions.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Delete an employee-attribute-definition"
}
}
}
},
"/lucca-api/employee-attributes": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"get": {
"x-beta": true,
"operationId": "get-employee-attributes",
"tags": [
"employee-attributes"
],
"summary": "List employee-attributes",
"description": "Returns a paginated list of employee-attributes.\n\nUnlike other API endpoints, access to employee attributes depends not only on an OAuth scope but also on access to the “sections” of the HR directory. [Learn more on this page](/api-reference/2024-11-01/employee-attributes/get-started#access).",
"parameters": [
{
"name": "id",
"in": "query",
"description": "Filter out employee-attributes on their IDs.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"123",
"456"
]
]
}
},
{
"name": "definition.id",
"in": "query",
"description": "Filter out employee-attributes on the `id` of their associated definition.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"jobPosition.manager",
"e_certifications",
"employee.familyName"
]
]
}
},
{
"name": "employee.id",
"in": "query",
"description": "Filter out employee-attributes on the `id` of the employee they belong to.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"123",
"456"
]
]
}
},
{
"name": "applicability.asOf",
"in": "query",
"description": "Only return employee-attributes whose applicability period includes the given date.\nAn attribute is considered applicable when its `applicability.start` is on or before the date\nand its `applicability.end` is on or after the date. Null bounds are treated as open-ended.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "applicability.strictAsOf",
"in": "query",
"description": "Only return employee-attributes whose strict applicability period includes the given date.\nSame semantics as `applicability.asOf`, but on `applicability.strictStart` / `applicability.strictEnd`,\nwhich do not fill the gaps between consecutive resources. A date falling in a period without any\ncontract therefore returns nothing.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "value",
"in": "query",
"description": "Filter out employee-attributes on their value.\n\nWhen the value is a JSON object, then supports sub-property filtering using dot notation (e.g. `value.foo=bar`).",
"schema": {
"type": "string"
}
},
{
"name": "-value",
"in": "query",
"description": "Filter out employee-attributes on their value, by exclusion (\"not\").\n\nWhen the value is a JSON object, then supports sub-property filtering using dot notation (e.g. `-value.foo=bar` meaning\n\"where `value.foo` is not equal to `bar`\").",
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "Order results by instruction. [Read more about sorting](/documentation/using-api/sorting). Default: `id`.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"default": [
"id"
],
"items": {
"type": "string",
"enum": [
"id",
"-id",
"createdAt",
"-createdAt",
"value",
"-value",
"definition.id",
"-definition.id"
]
}
}
},
{
"name": "lastUpdatedAt",
"in": "query",
"description": "Filter out employee-attributes on their `lastUpdatedAt` timestamp (range).",
"schema": {
"$ref": "#/components/schemas/datetimeoffsetrange"
}
},
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit1000"
}
],
"security": [
{
"oAuth": [
"employee-attributes.readonly"
]
},
{
"oAuth": [
"employee-attributes.readwrite"
]
}
],
"x-mint": {
"oauth": {
"establishments": "You may only access employee-attributes of employees whose applicable business-establishments are accessible to you.",
"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."
},
"href": "/api-reference/latest/employee-attributes/get-employee-attributes",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employee-attributes.readonly\n```\nor \n```\n employee-attributes.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access employee-attributes of employees whose applicable business-establishments are accessible to you.**\n\n\n\n---\n\n**Claims**\n\n This API endpoint will filter out results based on accessible claims. \n\n**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.**\n\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "List employee-attributes"
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A collection of [employee-attribute](/api-reference/2024-11-01/employee-attributes/employee-attribute) resources.",
"allOf": [
{
"$ref": "#/components/schemas/employee-attributes.read"
}
]
},
"examples": {
"values": {
"$ref": "#/components/examples/employee-attributes.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
}
},
"post": {
"x-beta": true,
"operationId": "post-employee-attribute",
"tags": [
"employee-attributes"
],
"summary": "Create an employee-attribute",
"description": "Create a new employee-attribute.",
"security": [
{
"oAuth": [
"employee-attributes.readwrite"
]
}
],
"requestBody": {
"description": "The employee-attribute to create.",
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "Representation of an employee-attribute.",
"allOf": [
{
"$ref": "#/components/schemas/employee-attribute.create"
}
]
},
"examples": {
"extensionScalar": {
"$ref": "#/components/examples/employee-attributes.post.example"
},
"multiValuedComposite": {
"$ref": "#/components/examples/employee-attributes.post.composite.example"
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"Location": {
"$ref": "#/components/headers/location"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The created employee-attribute resource.",
"allOf": [
{
"$ref": "#/components/schemas/employee-attribute.read"
}
]
},
"examples": {
"value": {
"$ref": "#/components/examples/employee-attribute.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/employee-attributes/post-employee-attribute",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employee-attributes.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Create an employee-attribute"
}
}
}
},
"/lucca-api/employee-attributes/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
},
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier of the employee-attribute.",
"schema": {
"type": "string",
"minLength": 1
}
}
],
"get": {
"x-beta": true,
"operationId": "get-employee-attribute",
"tags": [
"employee-attributes"
],
"summary": "Retrieve an employee-attribute",
"description": "Retrieve a single employee-attribute by ID.\n\nUnlike other API endpoints, access to employee attributes depends not only on an OAuth scope but also on access to the “sections” of the HR directory. [Learn more on this page](/api-reference/2024-11-01/employee-attributes/get-started#access).",
"security": [
{
"oAuth": [
"employee-attributes.readonly"
]
},
{
"oAuth": [
"employee-attributes.readwrite"
]
}
],
"x-mint": {
"oauth": {
"establishments": "You may only access employee-attributes of employees whose applicable business-establishments are accessible to you.",
"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."
},
"href": "/api-reference/latest/employee-attributes/get-employee-attribute",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employee-attributes.readonly\n```\nor \n```\n employee-attributes.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access employee-attributes of employees whose applicable business-establishments are accessible to you.**\n\n\n\n---\n\n**Claims**\n\n This API endpoint will filter out results based on accessible claims. \n\n**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.**\n\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Retrieve an employee-attribute"
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "An [employee-attribute](/api-reference/2024-11-01/employee-attributes/employee-attribute) resource.",
"allOf": [
{
"$ref": "#/components/schemas/employee-attribute.read"
}
]
},
"examples": {
"employee-attribute": {
"$ref": "#/components/examples/employee-attribute.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
}
},
"put": {
"x-beta": true,
"operationId": "put-employee-attribute",
"tags": [
"employee-attributes"
],
"summary": "Replace an employee-attribute",
"description": "Replace the value of an employee-attribute.\n\nThe `value` is replaced as a whole: for an object value, send all its properties, including the unchanged ones. An omitted `value` clears it, unless the attribute requires one.",
"security": [
{
"oAuth": [
"employee-attributes.readwrite"
]
}
],
"requestBody": {
"description": "Representation of an [employee-attribute](/api-reference/2024-11-01/employee-attributes/employee-attribute).",
"content": {
"application/json": {
"schema": {
"description": "The full representation of the employee-attribute.",
"allOf": [
{
"$ref": "#/components/schemas/employee-attribute.update"
}
]
},
"examples": {
"definition": {
"$ref": "#/components/examples/employee-attribute.patch.example"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The updated employee-attribute resource.",
"allOf": [
{
"$ref": "#/components/schemas/employee-attribute.read"
}
]
},
"examples": {
"definition": {
"$ref": "#/components/examples/employee-attribute.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/employee-attributes/put-employee-attribute",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employee-attributes.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Replace an employee-attribute"
}
}
},
"patch": {
"x-beta": true,
"operationId": "patch-employee-attribute",
"tags": [
"employee-attributes"
],
"summary": "Update an employee-attribute",
"description": "Update an employee-attribute.\n\nThe `value` is replaced as a whole: for an object value, send all its properties, including the unchanged ones.",
"security": [
{
"oAuth": [
"employee-attributes.readwrite"
]
}
],
"requestBody": {
"description": "Representation of an [employee-attribute](/api-reference/2024-11-01/employee-attributes/employee-attribute).",
"content": {
"application/json": {
"schema": {
"description": "The representation of the employee-attribute to update.",
"allOf": [
{
"$ref": "#/components/schemas/employee-attribute.update"
}
]
},
"examples": {
"definition": {
"$ref": "#/components/examples/employee-attribute.patch.example"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The updated employee-attribute resource.",
"allOf": [
{
"$ref": "#/components/schemas/employee-attribute.read"
}
]
},
"examples": {
"definition": {
"$ref": "#/components/examples/employee-attribute.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/employee-attributes/patch-employee-attribute",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employee-attributes.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Update an employee-attribute"
}
}
}
},
"/lucca-api/portraits/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
},
{
"name": "id",
"description": "Identifier of the portrait.",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"get": {
"x-beta": true,
"deprecated": true,
"operationId": "get-portrait",
"tags": [
"employees"
],
"summary": "Retrieve/Download a portrait",
"description": "Retrieve a single employee portrait, either as a JSON representation, or the actual image file.\n\nBy default, the API returns a JSON representation. In order to download the image, you must send `Accept: image/*` HTTP request header.\n\n**Deprecated**: download the portrait through the `links.files[\"{id}\"]` entry of the employee, read with\n`?include=links`, where `{id}` is the id of its `portrait`. Read more in [Get Started With Files](/api-reference/latest/files/get-started).",
"security": [
{
"oAuth": [
"employees.readonly"
]
},
{
"oAuth": [
"employees.readwrite"
]
}
],
"parameters": [
{
"name": "Accept",
"description": "Send `image/*` if you want to download the file. ",
"in": "header",
"schema": {
"type": "string",
"enum": [
"*/*",
"application/json",
"image/*"
],
"default": "application/json"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "JSON representation of the employee portrait.",
"allOf": [
{
"$ref": "#/components/schemas/portrait.read"
}
]
},
"examples": {
"portrait": {
"$ref": "#/components/examples/portrait.get.example"
}
}
},
"application/octet-stream": {
"schema": {
"description": "When downloading the image file.",
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/employees/get-portrait",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employees.readonly\n```\nor \n```\n employees.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Retrieve/Download a portrait"
}
}
}
},
"/lucca-api/employee-personal-records": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"get": {
"x-beta": true,
"operationId": "get-employee-personal-records",
"tags": [
"employees"
],
"summary": "List employee-personal-records",
"description": "Retrieve a paginated list of employee-personal-records.",
"security": [
{
"oAuth": [
"employee-personal-records.readonly"
]
},
{
"oAuth": [
"employee-personal-records.readwrite"
]
}
],
"x-mint": {
"oauth": {
"establishments": "You may only access employee-personal-records belonging to employees whose applicable business-establishments are accessible to you."
},
"href": "/api-reference/latest/employees/get-employee-personal-records",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employee-personal-records.readonly\n```\nor \n```\n employee-personal-records.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access employee-personal-records belonging to employees whose applicable business-establishments are accessible to you.**\n\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "List employee-personal-records"
}
},
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit1000"
},
{
"name": "employee.id",
"description": "Filter out personal-records on the employee IDs.",
"in": "query",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"123",
"456"
]
]
}
},
{
"name": "legalGender",
"description": "Filter out personal-records on the employee legal gender.",
"in": "query",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/legal-gender"
},
"examples": [
[
"male",
"female"
]
]
}
},
{
"name": "nationalitiesCountryCodes",
"description": "Only return employees who have at least one of the passed country codes nationalities.",
"in": "query",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/country-code"
},
"examples": [
[
"FRA",
"DEU"
]
]
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "An collection of employee-personal-record resources.",
"allOf": [
{
"$ref": "#/components/schemas/employee-personal-records.read"
}
]
},
"examples": {
"records": {
"$ref": "#/components/examples/employee-personal-records.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
}
}
},
"/lucca-api/employee-personal-records/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
},
{
"name": "id",
"description": "Identifier of the employee-personal-record to retrieve.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"x-beta": true,
"operationId": "get-employee-personal-record",
"tags": [
"employees"
],
"summary": "Retrieve an employee-personal-record",
"description": "Retrieve an employee-personal-record.",
"security": [
{
"oAuth": [
"employee-personal-records.readonly"
]
},
{
"oAuth": [
"employee-personal-records.readwrite"
]
}
],
"x-mint": {
"oauth": {
"establishments": "You may only access employee-personal-records belonging to employees whose applicable business-establishments are accessible to you."
},
"href": "/api-reference/latest/employees/get-employee-personal-record",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employee-personal-records.readonly\n```\nor \n```\n employee-personal-records.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access employee-personal-records belonging to employees whose applicable business-establishments are accessible to you.**\n\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Retrieve an employee-personal-record"
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "An employee-personal-record resource.",
"allOf": [
{
"$ref": "#/components/schemas/employee-personal-record.read"
}
]
},
"examples": {
"record": {
"$ref": "#/components/examples/employee-personal-record.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
}
}
},
"/lucca-api/employments": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"get": {
"x-beta": true,
"operationId": "get-employments",
"tags": [
"employments"
],
"summary": "List employments",
"description": "Returns a paginated list of employments.",
"parameters": [
{
"name": "id",
"in": "query",
"description": "Filter out employments on their IDs.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"123",
"456"
]
]
}
},
{
"name": "remoteId",
"in": "query",
"description": "Filter out employments on their remoteId.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"E500944",
"E500945"
]
]
}
},
{
"name": "employee.id",
"in": "query",
"description": "Filter out employments on their employee IDs.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"123",
"456"
]
]
}
},
{
"name": "legalEntity.id",
"in": "query",
"description": "Filter out employments on the legal-entity IDs.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"1",
"3"
]
]
}
},
{
"name": "template.id",
"in": "query",
"description": "Filter out employments on their employment-template IDs.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"4",
"6"
]
]
}
},
{
"name": "start.date",
"in": "query",
"description": "Filter out employments on their start.date (strict equality).",
"style": "form",
"explode": false,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "status",
"in": "query",
"description": "Filter out employments on their status.",
"schema": {
"$ref": "#/components/schemas/employee-status"
}
},
{
"name": "start.date.between",
"in": "query",
"description": "Filter out employments on their start.date (range). [ISO 8601 formatted date-range](/documentation/using-api/filtering#dates-date-times-and-date-time-offsets) string.",
"style": "form",
"explode": false,
"schema": {
"$ref": "#/components/schemas/daterange"
}
},
{
"name": "end.date",
"in": "query",
"description": "Filter out employments on their end.date (strict equality).",
"style": "form",
"explode": false,
"schema": {
"oneOf": [
{
"title": "date",
"type": "string",
"format": "date"
},
{
"title": "null",
"type": "string",
"const": "null"
}
]
}
},
{
"name": "end.date.between",
"in": "query",
"description": "Filter out employments on their end.date (range). [ISO 8601 formatted date-range](/documentation/using-api/filtering#dates-date-times-and-date-time-offsets) string.",
"style": "form",
"explode": false,
"schema": {
"$ref": "#/components/schemas/daterange"
}
},
{
"name": "sort",
"in": "query",
"description": "Order results by instruction. [Read more about sorting](/documentation/using-api/sorting). Default: `id`.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"default": [
"id"
],
"items": {
"type": "string",
"enum": [
"id",
"-id",
"start.date",
"-start.date",
"end.date",
"-end.date"
]
}
}
},
{
"name": "lastUpdatedAt",
"in": "query",
"description": "Filter out employments on their `lastUpdatedAt` timestamp (range).",
"schema": {
"$ref": "#/components/schemas/datetimeoffsetrange"
}
},
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit1000"
}
],
"security": [
{
"oAuth": [
"employments.readonly"
]
},
{
"oAuth": [
"employments.readwrite"
]
}
],
"x-mint": {
"oauth": {
"establishments": "You may only access employments belonging to employees whose applicable business-establishments are accessible to you."
},
"href": "/api-reference/latest/employments/get-employments",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employments.readonly\n```\nor \n```\n employments.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access employments belonging to employees whose applicable business-establishments are accessible to you.**\n\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "List employments"
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A collection of employment resources.",
"allOf": [
{
"$ref": "#/components/schemas/employments.read"
}
]
},
"examples": {
"employments": {
"$ref": "#/components/examples/employments.get.examples"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
}
},
"post": {
"x-beta": true,
"operationId": "post-employments",
"tags": [
"employments"
],
"summary": "Create an employment",
"description": "Create an employment for a employee in a legal-entity.\nNo two employments of a given employee may overlap.",
"security": [
{
"oAuth": [
"employments.readwrite",
"job-positions.readwrite"
]
}
],
"x-mint": {
"oauth": {
"establishments": "You may only access employments belonging to employees whose applicable business-establishments are accessible to you."
},
"href": "/api-reference/latest/employments/post-employments",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employments.readwrite job-positions.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access employments belonging to employees whose applicable business-establishments are accessible to you.**\n\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Create an employment"
}
},
"requestBody": {
"description": "The employment, and its first job-position to create.",
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"allOf": [
{
"$ref": "#/components/schemas/employment.create"
}
]
},
"examples": {
"employment": {
"$ref": "#/components/examples/employments.post.example"
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"Location": {
"$ref": "#/components/headers/location"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The created employment resource.",
"allOf": [
{
"$ref": "#/components/schemas/employment.read"
}
]
},
"examples": {
"employment": {
"$ref": "#/components/examples/employment.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"default": {
"$ref": "#/components/responses/500"
}
}
}
},
"/lucca-api/employments/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
},
{
"name": "id",
"description": "Identifier of the employment.",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"get": {
"x-beta": true,
"operationId": "get-employment",
"tags": [
"employments"
],
"summary": "Retrieve an employment",
"description": "Retrieve an employment by its ID.",
"security": [
{
"oAuth": [
"employments.readonly"
]
},
{
"oAuth": [
"employments.readwrite"
]
}
],
"x-mint": {
"oauth": {
"establishments": "You may only access employments belonging to employees whose applicable business-establishments are accessible to you."
},
"href": "/api-reference/latest/employments/get-employment",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employments.readonly\n```\nor \n```\n employments.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access employments belonging to employees whose applicable business-establishments are accessible to you.**\n\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Retrieve an employment"
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "An employment resource.",
"allOf": [
{
"$ref": "#/components/schemas/employment.read"
}
]
},
"examples": {
"employment": {
"$ref": "#/components/examples/employment.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
}
},
"patch": {
"x-beta": true,
"operationId": "patch-employment",
"tags": [
"employments"
],
"summary": "Update an employment",
"description": "Update an employment. This is a retroactive action.",
"security": [
{
"oAuth": [
"employments.readwrite"
]
}
],
"x-mint": {
"oauth": {
"establishments": "You may only access employments belonging to employees whose applicable business-establishments are accessible to you."
},
"href": "/api-reference/latest/employments/patch-employment",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employments.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access employments belonging to employees whose applicable business-establishments are accessible to you.**\n\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Update an employment"
}
},
"requestBody": {
"description": "Representation of an [employment](/api-reference/2024-11-01/employments/employment).",
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The (partial?) representation of the employment to update.",
"allOf": [
{
"$ref": "#/components/schemas/employment.update"
}
]
},
"examples": {
"employment": {
"$ref": "#/components/examples/employment.patch.example"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The updated employment resource.",
"allOf": [
{
"$ref": "#/components/schemas/employment.read"
}
]
},
"examples": {
"employment": {
"$ref": "#/components/examples/employment.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
}
},
"delete": {
"x-beta": true,
"operationId": "delete-employment",
"tags": [
"employments"
],
"summary": "Delete an employment",
"description": "You cannot delete the employment of an employee if it is the only one they have. In this case, please update it.\n\nDeleting an employment results in the deletion of all its [job-positions](/api-reference/2024-11-01/employments/job-position).",
"security": [
{
"oAuth": [
"employments.readwrite"
]
}
],
"x-mint": {
"oauth": {
"establishments": "You may only access employments belonging to employees whose applicable business-establishments are accessible to you."
},
"href": "/api-reference/latest/employments/delete-employment",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employments.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access employments belonging to employees whose applicable business-establishments are accessible to you.**\n\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Delete an employment"
}
},
"responses": {
"204": {
"description": "No Content",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
}
}
},
"/lucca-api/employment-templates": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"get": {
"x-beta": true,
"operationId": "get-employment-templates",
"tags": [
"employments"
],
"summary": "List employment-templates",
"description": "Retrieve a paginated list of employment-templates.",
"parameters": [
{
"name": "search",
"in": "query",
"description": "Find an employment-template by its title. The title must start with the given value.\nTranslated titles are searched as well.",
"schema": {
"type": "string",
"minLength": 1
}
},
{
"$ref": "#/components/parameters/is-archived"
},
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit1000"
}
],
"security": [
{
"oAuth": [
"employment-templates.readonly"
]
},
{
"oAuth": [
"employment-templates.readwrite"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A collection of employment-template resources.",
"allOf": [
{
"$ref": "#/components/schemas/employment-templates.read"
}
]
},
"examples": {
"employment-templates": {
"$ref": "#/components/examples/employment-templates.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/employments/get-employment-templates",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employment-templates.readonly\n```\nor \n```\n employment-templates.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "List employment-templates"
}
}
}
},
"/lucca-api/employment-templates/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
},
{
"name": "id",
"description": "Identifier of the employment-template.",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"get": {
"x-beta": true,
"operationId": "get-employment-template",
"tags": [
"employments"
],
"summary": "Retrieve an employment-template",
"description": "Retrieve an employment-template by its ID.",
"security": [
{
"oAuth": [
"employment-templates.readonly"
]
},
{
"oAuth": [
"employment-templates.readwrite"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "An employment-template resource.",
"allOf": [
{
"$ref": "#/components/schemas/employment-template.read"
}
]
},
"examples": {
"employment-template": {
"$ref": "#/components/examples/employment-template.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/employments/get-employment-template",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n employment-templates.readonly\n```\nor \n```\n employment-templates.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Retrieve an employment-template"
}
}
}
},
"/lucca-api/job-positions": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"get": {
"x-beta": true,
"operationId": "get-job-positions",
"tags": [
"employments"
],
"summary": "List job-positions",
"description": "Retrieve a paginated list of job-positions.",
"x-mint": {
"content": "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](/documentation/using-api/versioning). \n\n\n **Working-time arrangements are an opt-in feature.** \n You may not benefit from this feature. Working-time-arrangements are the\n replacement for the workcycles. If this feature has not been deployed on\n your environment, please contact our support.\n\n\n**OAuth 2.0 scopes**\n\n```\n job-positions.readonly\n```\nor \n```\n job-positions.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access job-positions belonging to employees whose applicable business-establishments are accessible to you.**\n\n",
"oauth": {
"establishments": "You may only access job-positions belonging to employees whose applicable business-establishments are accessible to you."
},
"href": "/api-reference/latest/employments/get-job-positions",
"metadata": {
"tag": "beta",
"sidebarTitle": "List job-positions"
}
},
"parameters": [
{
"name": "id",
"in": "query",
"description": "Filter out job-positions on their IDs.\nComma-separated list of strings.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"345",
"985"
]
]
}
},
{
"name": "remoteId",
"in": "query",
"description": "Filter out job-positions on their remoteId.\nComma-separated list of strings.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"JOB000423"
]
]
}
},
{
"name": "employment.id",
"in": "query",
"description": "Filter out job-positions on their [employment](/api-reference/2024-11-01/employments/employment) IDs.\nComma-separated list of strings.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"90",
"74"
]
]
}
},
{
"name": "businessEstablishment.id",
"in": "query",
"description": "Filter out job-positions on their [business-establishment](/api-reference/2024-11-01/organization/business-establishment) IDs.\nComma-separated list of strings.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"1",
"3"
]
]
}
},
{
"name": "status",
"in": "query",
"description": "Filter out employments on their status.",
"schema": {
"$ref": "#/components/schemas/employee-status"
}
},
{
"name": "startsOn",
"in": "query",
"description": "Filter out job-positions on their startsOn date (strict equality).",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "startsOn.between",
"in": "query",
"description": "Filter out job-positions on their startsOn date (range).\n[ISO 8601 formatted date-range](/documentation/using-api/filtering#dates-date-times-and-date-time-offsets) string.",
"schema": {
"$ref": "#/components/schemas/daterange"
}
},
{
"name": "endsOn",
"in": "query",
"description": "Filter out job-positions on their endsOn date (strict equality).",
"schema": {
"oneOf": [
{
"title": "date",
"type": "string",
"format": "date"
},
{
"title": "null",
"type": "string",
"const": "null"
}
]
}
},
{
"name": "endsOn.between",
"in": "query",
"description": "Filter out job-positions on their endsOn date (range).\n[ISO 8601 formatted date-range](/documentation/using-api/filtering#dates-date-times-and-date-time-offsets) string.",
"schema": {
"$ref": "#/components/schemas/daterange"
}
},
{
"name": "jobQualification.id",
"in": "query",
"description": "Filter out job-positions on their [job-qualification](/api-reference/2024-11-01/employee-job-qualifications/job-qualification) IDs.\nComma-separated list of strings.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"45",
"56"
]
]
}
},
{
"name": "occupationCategory.id",
"in": "query",
"description": "Filter out job-positions on their [occupation-category](/api-reference/2024-11-01/employee-occupation-categories/occupation-category) IDs.\nComma-separated list of strings.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"17",
"18"
]
]
}
},
{
"name": "manager.id",
"in": "query",
"description": "Filter out job-positions on their manager IDs.\nComma-separated list of strings.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"123",
"456"
]
]
}
},
{
"name": "department.id",
"in": "query",
"description": "Filter out job-positions on their [department](/api-reference/2024-11-01/organization/department) IDs.\nComma-separated list of strings.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1
},
"examples": [
[
"43"
]
]
}
},
{
"name": "updatedAttributes",
"in": "query",
"description": "Only return job-positions that changed one of the given attributes.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/job-position-changed-attributes"
},
"examples": [
[
"jobTitle"
]
]
}
},
{
"name": "sort",
"in": "query",
"description": "Order results by instruction. [Read more about sorting](/documentation/using-api/sorting). Default: `id`.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"maxItems": 100,
"default": [
"id"
],
"items": {
"type": "string",
"enum": [
"id",
"-id",
"startsOn",
"-startsOn",
"endsOn",
"-endsOn"
]
},
"examples": [
[
"id"
]
]
}
},
{
"name": "lastUpdatedAt",
"in": "query",
"description": "Filter out job-positions on their `lastUpdatedAt` timestamp (range).",
"schema": {
"$ref": "#/components/schemas/datetimeoffsetrange"
}
},
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit1000"
}
],
"security": [
{
"oAuth": [
"job-positions.readonly"
]
},
{
"oAuth": [
"job-positions.readwrite"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A collection of job-position resources.",
"allOf": [
{
"$ref": "#/components/schemas/job-positions.read"
}
]
},
"examples": {
"job-positions": {
"$ref": "#/components/examples/job-positions.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
}
},
"post": {
"x-beta": true,
"operationId": "post-job-positions",
"tags": [
"employments"
],
"summary": "Create a job-position",
"description": "Create an job-position for an employee's employment.\n\nNo two job-positions may overlap.",
"security": [
{
"oAuth": [
"job-positions.readwrite"
]
}
],
"x-mint": {
"oauth": {
"establishments": "You may only access job-positions belonging to employees whose applicable business-establishments are accessible to you."
},
"href": "/api-reference/latest/employments/post-job-positions",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n job-positions.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access job-positions belonging to employees whose applicable business-establishments are accessible to you.**\n\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Create a job-position"
}
},
"requestBody": {
"description": "Representation of a [job-position](/api-reference/2024-11-01/employments/job-position).",
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The job-position to create.",
"allOf": [
{
"$ref": "#/components/schemas/job-position.create"
}
]
},
"examples": {
"job-position": {
"$ref": "#/components/examples/job-positions.post.example"
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"Location": {
"$ref": "#/components/headers/location"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The created job-position resource.",
"allOf": [
{
"$ref": "#/components/schemas/job-position.read"
}
]
},
"examples": {
"job-position": {
"$ref": "#/components/examples/job-position.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"default": {
"$ref": "#/components/responses/500"
}
}
}
},
"/lucca-api/job-positions/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
},
{
"name": "id",
"description": "Identifier of the job-position to retrieve.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"x-beta": true,
"operationId": "get-job-position",
"tags": [
"employments"
],
"summary": "Retrieve a job-position",
"description": "Retrieve an job-position by its ID.",
"security": [
{
"oAuth": [
"job-positions.readonly"
]
},
{
"oAuth": [
"job-positions.readwrite"
]
}
],
"x-mint": {
"content": "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](/documentation/using-api/versioning). \n\n\n **Working-time arrangements are an opt-in feature.** \n You may not benefit from this feature. Working-time-arrangements are the\n replacement for the workcycles. If this feature has not been deployed on\n your environment, please contact our support.\n\n\n**OAuth 2.0 scopes**\n\n```\n job-positions.readonly\n```\nor \n```\n job-positions.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access job-positions belonging to employees whose applicable business-establishments are accessible to you.**\n\n",
"oauth": {
"establishments": "You may only access job-positions belonging to employees whose applicable business-establishments are accessible to you."
},
"href": "/api-reference/latest/employments/get-job-position",
"metadata": {
"tag": "beta",
"sidebarTitle": "Retrieve a job-position"
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A job-position resource.",
"allOf": [
{
"$ref": "#/components/schemas/job-position.read"
}
]
},
"examples": {
"job-position": {
"$ref": "#/components/examples/job-position.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
}
},
"patch": {
"x-beta": true,
"operationId": "patch-job-position",
"tags": [
"employments"
],
"summary": "Update a job-position",
"description": "Update a job-position.\n\nThis may be a retroactive action.",
"security": [
{
"oAuth": [
"job-positions.readwrite"
]
}
],
"x-mint": {
"oauth": {
"establishments": "You may only access job-positions belonging to employees whose applicable business-establishments are accessible to you."
},
"href": "/api-reference/latest/employments/patch-job-position",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n job-positions.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access job-positions belonging to employees whose applicable business-establishments are accessible to you.**\n\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Update a job-position"
}
},
"requestBody": {
"description": "Representation of a [job-position](/api-reference/2024-11-01/employments/job-position).",
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The (partial?) representation of the job-position to update.",
"allOf": [
{
"$ref": "#/components/schemas/job-position.update"
}
]
},
"examples": {
"job-position": {
"$ref": "#/components/examples/job-position.patch.example"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The updated job-position resource.",
"allOf": [
{
"$ref": "#/components/schemas/job-position.read"
}
]
},
"examples": {
"job-position": {
"$ref": "#/components/examples/job-position.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
}
},
"delete": {
"x-beta": true,
"operationId": "delete-job-position",
"tags": [
"employments"
],
"summary": "Delete a job-position",
"description": "Delete a job-position.",
"security": [
{
"oAuth": [
"job-positions.readwrite"
]
}
],
"x-mint": {
"oauth": {
"establishments": "You may only access job-positions belonging to employees whose applicable business-establishments are accessible to you."
},
"href": "/api-reference/latest/employments/delete-job-position",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n job-positions.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access job-positions belonging to employees whose applicable business-establishments are accessible to you.**\n\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Delete a job-position"
}
},
"responses": {
"204": {
"description": "No Content",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
}
}
},
"/lucca-api/probationary-periods": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"get": {
"x-beta": true,
"operationId": "get-probationary-periods",
"tags": [
"employments"
],
"summary": "List probationary-periods",
"description": "List probationary-periods.",
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit1000"
},
{
"name": "employment.employee.id",
"description": "Filter out probationary-periods on the related employee.",
"in": "query",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"example": [
"416"
]
}
},
{
"name": "employment.id",
"description": "Filter out probationary-periods on the employment they apply to.",
"in": "query",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"example": [
"4561"
]
}
},
{
"name": "startsOn.between",
"description": "Filter out probationary-periods on their start date (in a range).\n[ISO 8601 formatted date-range](/documentation/using-api/filtering#dates-date-times-and-date-time-offsets) string.",
"in": "query",
"schema": {
"$ref": "#/components/schemas/daterange"
}
},
{
"name": "endsOn.between",
"description": "Filter out probationary-periods on their end date (in a range).\n[ISO 8601 formatted date-range](/documentation/using-api/filtering#dates-date-times-and-date-time-offsets) string.",
"in": "query",
"schema": {
"$ref": "#/components/schemas/daterange"
}
},
{
"name": "initialEndsOn.between",
"description": "Filter out probationary-periods on their initial end date (in a range).\n[ISO 8601 formatted date-range](/documentation/using-api/filtering#dates-date-times-and-date-time-offsets) string.",
"in": "query",
"schema": {
"$ref": "#/components/schemas/daterange"
}
},
{
"name": "extendedEndsOn.between",
"description": "Filter out probationary-periods on their extended end date (in a range).\n[ISO 8601 formatted date-range](/documentation/using-api/filtering#dates-date-times-and-date-time-offsets) string.",
"in": "query",
"schema": {
"$ref": "#/components/schemas/daterange"
}
},
{
"name": "isExtended",
"description": "Filter out probationary-periods on whether they were extended (`true`) or not (`false`). When omitted, both extended and non-extended probationary-periods are returned.",
"in": "query",
"schema": {
"type": "boolean",
"example": true
}
},
{
"name": "sort",
"in": "query",
"description": "Order results by instruction. [Read more about sorting](/documentation/using-api/sorting). Default: `id`.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"default": [
"id"
],
"items": {
"type": "string",
"enum": [
"id",
"-id",
"startsOn",
"-startsOn",
"endsOn",
"-endsOn"
]
}
}
}
],
"security": [
{
"oAuth": [
"probationary-periods.readonly"
]
},
{
"oAuth": [
"probationary-periods.readwrite"
]
}
],
"x-mint": {
"oauth": {
"establishments": "You may only access probationary-periods belonging to employees whose applicable business-establishments are accessible to you."
},
"href": "/api-reference/latest/employments/get-probationary-periods",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n probationary-periods.readonly\n```\nor \n```\n probationary-periods.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access probationary-periods belonging to employees whose applicable business-establishments are accessible to you.**\n\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "List probationary-periods"
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A collection of probationary-period resources.",
"allOf": [
{
"$ref": "#/components/schemas/probationary-periods.read"
}
]
},
"examples": {
"periods": {
"$ref": "#/components/examples/probationary-periods.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
}
},
"post": {
"x-beta": true,
"operationId": "post-probationary-period",
"tags": [
"employments"
],
"summary": "Create a probationary-period",
"description": "Create a new probationary-period.",
"security": [
{
"oAuth": [
"probationary-periods.readwrite"
]
}
],
"x-mint": {
"oauth": {
"establishments": "You may only access probationary-periods belonging to employees whose applicable business-establishments are accessible to you."
},
"href": "/api-reference/latest/employments/post-probationary-period",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n probationary-periods.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access probationary-periods belonging to employees whose applicable business-establishments are accessible to you.**\n\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Create a probationary-period"
}
},
"requestBody": {
"description": "Representation of a [probationary-period](/api-reference/2024-11-01/employments/probationary-period).",
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The probationary-period to create.",
"allOf": [
{
"$ref": "#/components/schemas/probationary-period.create"
}
]
},
"examples": {
"period": {
"$ref": "#/components/examples/probationary-period.post.example"
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"Location": {
"$ref": "#/components/headers/location"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The created probationary-period resource.",
"allOf": [
{
"$ref": "#/components/schemas/probationary-period.read"
}
]
},
"examples": {
"period": {
"$ref": "#/components/examples/probationary-period.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"default": {
"$ref": "#/components/responses/500"
}
}
}
},
"/lucca-api/probationary-periods/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/include"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier of the probationary-period",
"schema": {
"type": "string",
"minLength": 1
}
}
],
"get": {
"x-beta": true,
"operationId": "get-probationary-period",
"summary": "Retrieve a probationary-period",
"description": "Retrieve a probationary-period by its ID.",
"tags": [
"employments"
],
"security": [
{
"oAuth": [
"probationary-periods.readonly"
]
},
{
"oAuth": [
"probationary-periods.readwrite"
]
}
],
"x-mint": {
"oauth": {
"establishments": "You may only access probationary-periods belonging to employees whose applicable business-establishments are accessible to you."
},
"href": "/api-reference/latest/employments/get-probationary-period",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n probationary-periods.readonly\n```\nor \n```\n probationary-periods.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access probationary-periods belonging to employees whose applicable business-establishments are accessible to you.**\n\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Retrieve a probationary-period"
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A probationary-period resource.",
"allOf": [
{
"$ref": "#/components/schemas/probationary-period.read"
}
]
},
"examples": {
"period": {
"$ref": "#/components/examples/probationary-period.get.example"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
}
},
"patch": {
"x-beta": true,
"operationId": "put-probationary-period",
"summary": "Update a probationary-period",
"description": "Update a probationary-period by its ID.",
"tags": [
"employments"
],
"security": [
{
"oAuth": [
"probationary-periods.readwrite"
]
}
],
"x-mint": {
"oauth": {
"establishments": "You may only access probationary-periods belonging to employees whose applicable business-establishments are accessible to you."
},
"href": "/api-reference/latest/employments/put-probationary-period",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n probationary-periods.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access probationary-periods belonging to employees whose applicable business-establishments are accessible to you.**\n\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Update a probationary-period"
}
},
"requestBody": {
"description": "The (partial?) representation of the probationary-period to update.",
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The (partial?) representation of the probationary-period to update.",
"allOf": [
{
"$ref": "#/components/schemas/probationary-period.update"
}
]
},
"examples": {
"period": {
"$ref": "#/components/examples/probationary-period.patch.example"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The updated probationary-period resource.",
"allOf": [
{
"$ref": "#/components/schemas/probationary-period.read"
}
]
},
"examples": {
"period": {
"$ref": "#/components/examples/probationary-period.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
}
},
"delete": {
"x-beta": true,
"operationId": "delete-probationary-period",
"summary": "Delete a probationary-period",
"description": "Delete a probationary-period by its ID.",
"tags": [
"employments"
],
"security": [
{
"oAuth": [
"probationary-periods.readwrite"
]
}
],
"x-mint": {
"oauth": {
"establishments": "You may only access probationary-periods belonging to employees whose applicable business-establishments are accessible to you."
},
"href": "/api-reference/latest/employments/delete-probationary-period",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n probationary-periods.readwrite\n```\n\n\n---\n\n**Establishments**\n\n This API endpoint will filter out results based on accessible business-establishments. \n\n**You may only access probationary-periods belonging to employees whose applicable business-establishments are accessible to you.**\n\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Delete a probationary-period"
}
},
"responses": {
"204": {
"description": "No Content",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
}
}
},
"/lucca-api/taxonomies": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"get": {
"x-beta": true,
"operationId": "get-taxonomies",
"tags": [
"taxonomies"
],
"summary": "List taxonomies",
"description": "Returns a paginated list of taxonomies.",
"security": [
{
"oAuth": [
"taxonomies.readonly"
]
},
{
"oAuth": [
"taxonomies.readwrite"
]
},
{
"oAuth": [
"employee-attribute-definitions.readonly"
]
},
{
"oAuth": [
"employee-attribute-definitions.readwrite"
]
}
],
"parameters": [
{
"name": "search",
"description": "Find a taxonomy whose name must start with all of the given words. Each word can be delimited with any of these delimiters: `[' ', '-', '_', ',', '.']`.",
"in": "query",
"schema": {
"type": "string",
"minLength": 1
}
},
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit1000"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Location": {
"$ref": "#/components/headers/location"
},
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A collection of taxonomy resources.",
"allOf": [
{
"$ref": "#/components/schemas/taxonomies.read"
}
]
},
"examples": {
"taxonomies": {
"$ref": "#/components/examples/taxonomies.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/taxonomies/get-taxonomies",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n taxonomies.readonly\n```\nor \n```\n taxonomies.readwrite\n```\nor \n```\n employee-attribute-definitions.readonly\n```\nor \n```\n employee-attribute-definitions.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "List taxonomies"
}
}
},
"post": {
"x-beta": true,
"operationId": "post-taxonomy",
"tags": [
"taxonomies"
],
"summary": "Create a taxonomy",
"description": "Create a new taxonomy.",
"security": [
{
"oAuth": [
"taxonomies.readwrite"
]
},
{
"oAuth": [
"employee-attribute-definitions.readwrite"
]
}
],
"requestBody": {
"description": "Representation of a [taxonomy](/api-reference/2024-11-01/taxonomies/taxonomy).",
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The taxonomy to create.",
"allOf": [
{
"$ref": "#/components/schemas/taxonomy.create"
}
]
},
"examples": {
"taxonomy": {
"$ref": "#/components/examples/taxonomies.post.example"
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"Location": {
"$ref": "#/components/headers/location"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The created taxonomy resource.",
"allOf": [
{
"$ref": "#/components/schemas/taxonomy.read"
}
]
},
"examples": {
"taxonomy": {
"$ref": "#/components/examples/taxonomy.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/taxonomies/post-taxonomy",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n taxonomies.readwrite\n```\nor \n```\n employee-attribute-definitions.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Create a taxonomy"
}
}
}
},
"/lucca-api/taxonomies/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/include"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier of the taxonomy",
"schema": {
"type": "string",
"minLength": 1
}
}
],
"get": {
"x-beta": true,
"operationId": "get-taxonomy",
"summary": "Retrieve a taxonomy",
"description": "Retrieve a taxonomy by its ID.",
"tags": [
"taxonomies"
],
"security": [
{
"oAuth": [
"taxonomies.readonly"
]
},
{
"oAuth": [
"taxonomies.readwrite"
]
},
{
"oAuth": [
"employee-attribute-definitions.readonly"
]
},
{
"oAuth": [
"employee-attribute-definitions.readwrite"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A taxonomy resource.",
"allOf": [
{
"$ref": "#/components/schemas/taxonomy.read"
}
]
},
"examples": {
"taxonomy": {
"$ref": "#/components/examples/taxonomy.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/taxonomies/get-taxonomy",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n taxonomies.readonly\n```\nor \n```\n taxonomies.readwrite\n```\nor \n```\n employee-attribute-definitions.readonly\n```\nor \n```\n employee-attribute-definitions.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Retrieve a taxonomy"
}
}
},
"put": {
"x-beta": true,
"operationId": "put-taxonomy",
"tags": [
"taxonomies"
],
"summary": "Replace a taxonomy",
"description": "Replace a taxonomy. This is a retroactive action.\n\nUnlike `PATCH`, the request body replaces the whole taxonomy: an omitted `sortLabelsBy` is reset to `id`, and omitted translations are removed.",
"security": [
{
"oAuth": [
"taxonomies.readwrite"
]
},
{
"oAuth": [
"employee-attribute-definitions.readwrite"
]
}
],
"requestBody": {
"description": "Representation of an [taxonomy](/api-reference/2024-11-01/taxonomies/taxonomy).",
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The full representation of the taxonomy.",
"required": [
"name"
],
"allOf": [
{
"$ref": "#/components/schemas/taxonomy.update"
}
]
},
"examples": {
"taxonomy": {
"$ref": "#/components/examples/taxonomy.patch.example"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The updated taxonomy resource.",
"allOf": [
{
"$ref": "#/components/schemas/taxonomy.read"
}
]
},
"examples": {
"taxonomy": {
"$ref": "#/components/examples/taxonomy.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/taxonomies/put-taxonomy",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n taxonomies.readwrite\n```\nor \n```\n employee-attribute-definitions.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Replace a taxonomy"
}
}
},
"patch": {
"x-beta": true,
"operationId": "patch-taxonomy",
"tags": [
"taxonomies"
],
"summary": "Update a taxonomy",
"description": "Update a taxonomy. This is a retroactive action.",
"security": [
{
"oAuth": [
"taxonomies.readwrite"
]
},
{
"oAuth": [
"employee-attribute-definitions.readwrite"
]
}
],
"requestBody": {
"description": "Representation of an [taxonomy](/api-reference/2024-11-01/taxonomies/taxonomy).",
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The (partial?) representation of the taxonomy to update.",
"allOf": [
{
"$ref": "#/components/schemas/taxonomy.update"
}
]
},
"examples": {
"taxonomy": {
"$ref": "#/components/examples/taxonomy.patch.example"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The updated taxonomy resource.",
"allOf": [
{
"$ref": "#/components/schemas/taxonomy.read"
}
]
},
"examples": {
"taxonomy": {
"$ref": "#/components/examples/taxonomy.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/taxonomies/patch-taxonomy",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n taxonomies.readwrite\n```\nor \n```\n employee-attribute-definitions.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Update a taxonomy"
}
}
},
"delete": {
"x-beta": true,
"operationId": "delete-taxonomy",
"tags": [
"taxonomies"
],
"summary": "Delete a taxonomy",
"description": "Deleting a taxonomy results in the deletion of all its [taxonomy-labels](/api-reference/2024-11-01/taxonomies/taxonomy-label).",
"security": [
{
"oAuth": [
"taxonomies.readwrite"
]
},
{
"oAuth": [
"employee-attribute-definitions.readwrite"
]
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/taxonomies/delete-taxonomy",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n taxonomies.readwrite\n```\nor \n```\n employee-attribute-definitions.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Delete a taxonomy"
}
}
}
},
"/lucca-api/taxonomy-labels": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"get": {
"x-beta": true,
"operationId": "get-taxonomy-labels",
"tags": [
"taxonomies"
],
"summary": "List taxonomy-labels",
"description": "Returns a paginated list of taxonomy-labels.",
"security": [
{
"oAuth": [
"taxonomies.readonly"
]
},
{
"oAuth": [
"taxonomies.readwrite"
]
}
],
"parameters": [
{
"name": "taxonomy.id",
"description": "Filter out taxonomy-labels by the taxonomy they belong to.",
"in": "query",
"schema": {
"type": "string",
"minLength": 1
},
"examples": {
"45": {
"value": "45",
"summary": "Only return taxonomy-labels belonging to taxonomy ID \"45\"."
}
}
},
{
"name": "search",
"description": "Find a taxonomy-label whose name must start with all of the given words. Each word can be delimited with any of these delimiters: `[' ', '-', '_', ',', '.']`.",
"in": "query",
"schema": {
"type": "string",
"minLength": 1
}
},
{
"$ref": "#/components/parameters/is-archived"
},
{
"name": "sort",
"description": "Sort taxonomy-labels. Most often, you want to interpolate the taxonomy `sortLabelsBy` property value.",
"in": "query",
"schema": {
"$ref": "#/components/schemas/taxonomy.sortLabelsBy"
}
},
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit1000"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Location": {
"$ref": "#/components/headers/location"
},
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A collection of taxonomy-label resources.",
"allOf": [
{
"$ref": "#/components/schemas/taxonomy-labels.read"
}
]
},
"examples": {
"taxonomies": {
"$ref": "#/components/examples/taxonomy-labels.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/taxonomies/get-taxonomy-labels",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n taxonomies.readonly\n```\nor \n```\n taxonomies.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "List taxonomy-labels"
}
}
},
"post": {
"x-beta": true,
"operationId": "post-taxonomy-label",
"tags": [
"taxonomies"
],
"summary": "Create a taxonomy-label",
"description": "Create a new taxonomy-label.",
"security": [
{
"oAuth": [
"taxonomies.readwrite"
]
}
],
"requestBody": {
"description": "Representation of a [taxonomy-label](/api-reference/2024-11-01/taxonomies/taxonomy-label).",
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The taxonomy-label to create.",
"allOf": [
{
"$ref": "#/components/schemas/taxonomy-label.create"
}
]
},
"examples": {
"taxonomy": {
"$ref": "#/components/examples/taxonomy-labels.post.example"
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"Location": {
"$ref": "#/components/headers/location"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The created taxonomy-label resource.",
"allOf": [
{
"$ref": "#/components/schemas/taxonomy-label.read"
}
]
},
"examples": {
"taxonomy": {
"$ref": "#/components/examples/taxonomy-label.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/taxonomies/post-taxonomy-label",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n taxonomies.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Create a taxonomy-label"
}
}
}
},
"/lucca-api/taxonomy-labels/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/include"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier of the taxonomy-label",
"schema": {
"type": "string",
"minLength": 1
}
}
],
"get": {
"x-beta": true,
"operationId": "get-taxonomy-label",
"summary": "Retrieve a taxonomy-label",
"description": "Retrieve a taxonomy-label by its ID.",
"tags": [
"taxonomies"
],
"security": [
{
"oAuth": [
"taxonomies.readonly"
]
},
{
"oAuth": [
"taxonomies.readwrite"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A taxonomy-label resource.",
"allOf": [
{
"$ref": "#/components/schemas/taxonomy-label.read"
}
]
},
"examples": {
"label": {
"$ref": "#/components/examples/taxonomy-label.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/taxonomies/get-taxonomy-label",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n taxonomies.readonly\n```\nor \n```\n taxonomies.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Retrieve a taxonomy-label"
}
}
},
"put": {
"x-beta": true,
"operationId": "put-taxonomy-label",
"tags": [
"taxonomies"
],
"summary": "Replace a taxonomy-label",
"description": "Replace a taxonomy-label.\n\nUnlike `PATCH`, the request body replaces the whole taxonomy-label: an omitted `remoteId` is cleared, and omitted translations are removed. An omitted `isArchived` leaves the archive status unchanged.",
"security": [
{
"oAuth": [
"taxonomies.readwrite"
]
}
],
"requestBody": {
"description": "Representation of an [taxonomy-label](/api-reference/2024-11-01/taxonomies/taxonomy-label).",
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The full representation of the taxonomy-label.",
"required": [
"name"
],
"allOf": [
{
"$ref": "#/components/schemas/taxonomy-label.update"
}
]
},
"examples": {
"taxonomy-label": {
"$ref": "#/components/examples/taxonomy-label.patch.example"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The updated taxonomy-label resource.",
"allOf": [
{
"$ref": "#/components/schemas/taxonomy-label.read"
}
]
},
"examples": {
"taxonomy-label": {
"$ref": "#/components/examples/taxonomy-label.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/taxonomies/put-taxonomy-label",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n taxonomies.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Replace a taxonomy-label"
}
}
},
"patch": {
"x-beta": true,
"operationId": "patch-taxonomy-label",
"tags": [
"taxonomies"
],
"summary": "Update a taxonomy-label",
"description": "Update a taxonomy-label.",
"security": [
{
"oAuth": [
"taxonomies.readwrite"
]
}
],
"requestBody": {
"description": "Representation of an [taxonomy-label](/api-reference/2024-11-01/taxonomies/taxonomy-label).",
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The (partial?) representation of the taxonomy-label to update.",
"allOf": [
{
"$ref": "#/components/schemas/taxonomy-label.update"
}
]
},
"examples": {
"taxonomy-label": {
"$ref": "#/components/examples/taxonomy-label.patch.example"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The updated taxonomy-label resource.",
"allOf": [
{
"$ref": "#/components/schemas/taxonomy-label.read"
}
]
},
"examples": {
"taxonomy-label": {
"$ref": "#/components/examples/taxonomy-label.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/taxonomies/patch-taxonomy-label",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n taxonomies.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Update a taxonomy-label"
}
}
},
"delete": {
"x-beta": true,
"operationId": "delete-taxonomy-label",
"tags": [
"taxonomies"
],
"summary": "Delete a taxonomy-label",
"description": "Permanently delete a taxonomy-label by its ID. To hide a label while keeping it, archive it with `PATCH` and `isArchived: true` instead.\n\nA label that is still used by an employee-attribute value, whatever its period, returns a `400` with the `taxonomy-label-is-referenced` error. A read-only label, synchronized by Lucca (e.g. contract end reasons), returns a `400` with the `taxonomy-label-readonly` error.",
"security": [
{
"oAuth": [
"taxonomies.readwrite"
]
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/taxonomies/delete-taxonomy-label",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n taxonomies.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Delete a taxonomy-label"
}
}
}
},
"/lucca-api/leave-requests/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
},
{
"name": "id",
"description": "Unique id of the leave-request.",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/lucca-api/working-time-arrangements": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"get": {
"x-beta": true,
"operationId": "get-working-time-arrangements",
"tags": [
"working-time-arrangements"
],
"summary": "List working-time-arrangements",
"description": "Returns a paginated list of working-time-arrangements.\n\n\n You may not benefit from this feature. Working-time-arrangements are the\n replacement for the workcycles. If this feature has not been deployed on\n your environment, please contact our support.\n",
"security": [
{
"oAuth": [
"working-time-arrangements.readonly"
]
}
],
"parameters": [
{
"name": "limit",
"in": "query",
"description": "Number of items per page. Defaults to 10. Maximum is 1,000.\nRead more about [pagination](/documentation/using-api/paging).",
"schema": {
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 1000
},
"examples": {
"one": {
"summary": "Retrieve 10 items.",
"value": 10
}
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A collection of working-time-arrangement resources.",
"allOf": [
{
"$ref": "#/components/schemas/working-time-arrangements.read"
}
]
},
"examples": {
"wta": {
"$ref": "#/components/examples/working-time-arrangements.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/working-time-arrangements/get-working-time-arrangements",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n working-time-arrangements.readonly\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "List working-time-arrangements"
}
}
}
},
"/lucca-api/working-time-arrangements/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
},
{
"name": "id",
"description": "Unique id of the working-time-arrangement.",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"get": {
"x-beta": true,
"operationId": "get-working-time-arrangement",
"tags": [
"working-time-arrangements"
],
"summary": "Retrieve a working-time-arrangement",
"description": "Retrieves a single working-time-arrangement resource.\n\n\n You may not benefit from this feature. Working-time-arrangements are the\n replacement for the workcycles. If this feature has not been deployed on\n your environment, please contact our support.\n",
"security": [
{
"oAuth": [
"working-time-arrangements.readonly"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A working-time-arrangement resource.",
"allOf": [
{
"$ref": "#/components/schemas/working-time-arrangement.read"
}
]
},
"examples": {
"wta": {
"$ref": "#/components/examples/working-time-arrangement.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/working-time-arrangements/get-working-time-arrangement",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n working-time-arrangements.readonly\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Retrieve a working-time-arrangement"
}
}
}
},
"/lucca-api/events": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"get": {
"x-beta": true,
"operationId": "get-events",
"tags": [
"events"
],
"summary": "List events",
"description": "Returns a paginated list of events.",
"security": [
{
"oAuth": [
"events.readonly"
]
}
],
"parameters": [
{
"in": "header",
"name": "Accept",
"description": "Both `application/json` and `application/cloudevents-batch+json` are accepted.",
"schema": {
"type": "string",
"enum": [
"application/json",
"application/cloudevents-batch+json"
],
"x-enumDescriptions": {
"application/json": "Return events in default JSON format.",
"application/cloudevents-batch+json": "Return events in the cloudevents format."
}
}
},
{
"name": "status",
"in": "query",
"description": "Delivery status",
"schema": {
"type": "string",
"enum": [
"scheduled",
"delivered",
"failed"
],
"x-enumDescriptions": {
"scheduled": "a",
"delivered": "b",
"failed": "c"
}
}
},
{
"$ref": "#/components/parameters/limit.default20"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A collection of event resources.",
"allOf": [
{
"$ref": "#/components/schemas/events.read"
}
]
},
"examples": {
"events": {
"$ref": "#/components/examples/events.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/events/get-events",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n events.readonly\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "List events"
}
}
}
},
"/lucca-api/events/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
},
{
"name": "id",
"description": "Identifier of the event to retrieve.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"x-beta": true,
"operationId": "get-event",
"tags": [
"events"
],
"summary": "Retrieve an event",
"description": "Retrieve an event by its ID.",
"security": [
{
"oAuth": [
"events.readonly"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "An event resource.",
"allOf": [
{
"$ref": "#/components/schemas/event.read"
}
]
},
"examples": {
"event": {
"$ref": "#/components/examples/event.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/events/get-event",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n events.readonly\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Retrieve an event"
}
}
}
},
"/lucca-api/webhook-endpoints": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"get": {
"x-beta": true,
"operationId": "get-webhook-endpoints",
"tags": [
"webhooks"
],
"summary": "List webhook-endpoints",
"description": "Returns a paginated list of webhook-endpoints.",
"security": [
{
"oAuth": [
"webhook-endpoints.readonly"
]
},
{
"oAuth": [
"webhook-endpoints.readwrite"
]
}
],
"parameters": [
{
"name": "status",
"in": "query",
"style": "form",
"explode": false,
"description": "Only return webhook-endpoints that are at one of the given statuses.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"active",
"suspended",
"inactive"
],
"x-enumDescriptions": {
"active": "Webhook-endpoints actively sending messages.",
"suspended": "Webhook-endpoints not sending any message with still keeping track of them.",
"inactive": "Webhook-endpoints not sending any message nor keeping track of them."
}
},
"example": [
"active"
]
}
},
{
"$ref": "#/components/parameters/limit.default20"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A collection of webhook-endpoint resources.",
"allOf": [
{
"$ref": "#/components/schemas/webhook-endpoints.read"
}
]
},
"examples": {
"endpoint": {
"$ref": "#/components/examples/webhook-endpoints.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/webhooks/get-webhook-endpoints",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n webhook-endpoints.readonly\n```\nor \n```\n webhook-endpoints.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "List webhook-endpoints"
}
}
},
"post": {
"x-beta": true,
"operationId": "post-webhook-endpoints",
"summary": "Create a webhook-endpoint",
"description": "Create a new webhook-endpoint.",
"tags": [
"webhooks"
],
"security": [
{
"oAuth": [
"webhook-endpoints.readwrite"
]
}
],
"x-mint": {
"content": "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](/documentation/using-api/versioning). \n\nThe receiving endpoint given in `webhookUrl` must be able to respond to the [activation challenge](/documentation/webhooks/catching/spec-activate), unless it's a Zapier hooks catcher.\n\nMake sure to keep the secret returned in the POST response. You will not be able to GET it later.\n\n**OAuth 2.0 scopes**\n\n```\n webhook-endpoints.readwrite\n```\n",
"href": "/api-reference/latest/webhooks/post-webhook-endpoints",
"metadata": {
"tag": "beta",
"sidebarTitle": "Create a webhook-endpoint"
}
},
"requestBody": {
"description": "Representation of a [webhook-endpoint](/api-reference/2024-11-01/webhooks/webhook-endpoint)",
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The webhook-endpoint to create.",
"allOf": [
{
"$ref": "#/components/schemas/webhook-endpoint.create"
}
]
},
"examples": {
"endpoint": {
"$ref": "#/components/examples/webhook-endpoints.post.example"
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"Location": {
"$ref": "#/components/headers/location"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"allOf": [
{
"$ref": "#/components/schemas/webhook-endpoint.read"
},
{
"description": "The created webhook-endpoint resource.",
"type": "object",
"required": [
"secret"
],
"properties": {
"secret": {
"type": "string",
"minLength": 1
}
}
}
]
},
"examples": {
"webhook-endpoint": {
"$ref": "#/components/examples/webhook-endpoints.post.resp.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"default": {
"$ref": "#/components/responses/500"
}
}
}
},
"/lucca-api/webhook-endpoints/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/include"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier of the webhook-endpoint.",
"schema": {
"type": "string"
}
}
],
"get": {
"x-beta": true,
"operationId": "get-webhook-endpoint",
"tags": [
"webhooks"
],
"summary": "Retrieve a webhook-endpoint",
"description": "Retrieves a single webhook-endpoint resource.",
"security": [
{
"oAuth": [
"webhook-endpoints.readonly"
]
},
{
"oAuth": [
"webhook-endpoints.readwrite"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A webhook-endpoint resource.",
"allOf": [
{
"$ref": "#/components/schemas/webhook-endpoint.read"
}
]
},
"examples": {
"endpoint": {
"$ref": "#/components/examples/webhook-endpoint.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/webhooks/get-webhook-endpoint",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n webhook-endpoints.readonly\n```\nor \n```\n webhook-endpoints.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Retrieve a webhook-endpoint"
}
}
},
"patch": {
"x-beta": true,
"operationId": "patch-webhook-endpoint",
"summary": "Update a webhook-endpoint",
"tags": [
"webhooks"
],
"security": [
{
"oAuth": [
"webhook-endpoints.readwrite"
]
}
],
"description": "Update an existing webhook-endpoint.\n\nNote: `businessEstablishments` cannot be modified once the endpoint has been created.",
"requestBody": {
"description": "Representation of a [webhook-endpoint](/api-reference/2024-11-01/webhooks/webhook-endpoint)",
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The partial representation of the webhook-endpoint to update.",
"allOf": [
{
"$ref": "#/components/schemas/webhook-endpoint.update"
}
]
},
"examples": {
"endpoint": {
"$ref": "#/components/examples/webhook-endpoint.patch.example"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The updated webhook-endpoint resource.",
"allOf": [
{
"$ref": "#/components/schemas/webhook-endpoint.read"
}
]
},
"examples": {
"endpoint": {
"$ref": "#/components/examples/webhook-endpoint.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/webhooks/patch-webhook-endpoint",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n webhook-endpoints.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Update a webhook-endpoint"
}
}
},
"delete": {
"x-beta": true,
"operationId": "delete-webhook-endpoint",
"summary": "Delete a webhook-endpoint",
"tags": [
"webhooks"
],
"security": [
{
"oAuth": [
"webhook-endpoints.readwrite"
]
}
],
"description": "Delete an existing webhook-endpoint.",
"responses": {
"204": {
"description": "No Content",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
}
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/webhooks/delete-webhook-endpoint",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n webhook-endpoints.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Delete a webhook-endpoint"
}
}
}
},
"/lucca-api/webhook-deliveries": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"get": {
"x-beta": true,
"operationId": "get-webhook-deliveries",
"tags": [
"webhooks"
],
"summary": "List webhook-deliveries",
"description": "Returns a paginated list of webhook-deliveries.\n\nTwo formats (i.e. Content-Types) are supported:\n1. the default application/json format ;\n2. a CloudEvent compliant format.",
"security": [
{
"oAuth": [
"webhook-deliveries.readonly"
]
},
{
"oAuth": [
"webhook-deliveries.readwrite"
]
}
],
"parameters": [
{
"$ref": "#/components/parameters/limit.default20"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Location": {
"$ref": "#/components/headers/location"
},
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A collection of webhook-delivery resources.",
"allOf": [
{
"$ref": "#/components/schemas/webhook-deliveries.read"
}
]
},
"examples": {
"deliveries": {
"$ref": "#/components/examples/webhook-deliveries.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/webhooks/get-webhook-deliveries",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n webhook-deliveries.readonly\n```\nor \n```\n webhook-deliveries.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "List webhook-deliveries"
}
}
},
"post": {
"x-beta": true,
"operationId": "post-webhook-deliveries",
"tags": [
"webhooks"
],
"summary": "Trigger a test delivery",
"description": "Triggers a test delivery to in order to test it out a webhook-endpoint.",
"security": [
{
"oAuth": [
"webhook-deliveries.readwrite"
]
}
],
"x-mint": {
"content": "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](/documentation/using-api/versioning). \n\nYou may refer to this [example of a test event](/api-reference/2024-11-01/events/test-event)\n\n**OAuth 2.0 scopes**\n\n```\n webhook-deliveries.readwrite\n```\n",
"href": "/api-reference/latest/webhooks/post-webhook-deliveries",
"metadata": {
"tag": "beta",
"sidebarTitle": "Trigger a test delivery"
}
},
"requestBody": {
"description": "The webhook-endpoint to test.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/webhook-delivery.create"
},
"examples": {
"delivery": {
"$ref": "#/components/examples/webhook-delivery.post.example"
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"Location": {
"$ref": "#/components/headers/location"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "The created webhook-delivery resource.",
"allOf": [
{
"$ref": "#/components/schemas/webhook-delivery.read"
}
]
},
"examples": {
"delivery": {
"$ref": "#/components/examples/webhook-delivery.get.example"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"default": {
"$ref": "#/components/responses/500"
}
}
}
},
"/lucca-api/webhook-deliveries/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
},
{
"name": "id",
"in": "path",
"required": true,
"description": "ID of the webhook-delivery.",
"schema": {
"type": "string",
"minLength": 1
}
}
],
"get": {
"x-beta": true,
"operationId": "get-webhook-delivery",
"summary": "Retrieve a webhook-delivery",
"description": "Retrieve a webhook-delivery.",
"tags": [
"webhooks"
],
"security": [
{
"oAuth": [
"webhook-deliveries.readonly"
]
},
{
"oAuth": [
"webhook-deliveries.readwrite"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A webhook-delivery resource.",
"allOf": [
{
"$ref": "#/components/schemas/webhook-delivery.read"
}
]
},
"examples": {
"delivery": {
"$ref": "#/components/examples/webhook-delivery.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/webhooks/get-webhook-delivery",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n webhook-deliveries.readonly\n```\nor \n```\n webhook-deliveries.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Retrieve a webhook-delivery"
}
}
}
},
"/lucca-api/webhook-delivery-attempts": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/include"
}
],
"get": {
"x-beta": true,
"operationId": "get-webhook-delivery-attempts",
"summary": "List webhook-delivery-attempts",
"description": "Retrieve a paginated list of webhook-delivery-attempts.",
"tags": [
"webhooks"
],
"security": [
{
"oAuth": [
"webhook-deliveries.readonly"
]
},
{
"oAuth": [
"webhook-deliveries.readwrite"
]
}
],
"parameters": [
{
"$ref": "#/components/parameters/limit.default20"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A collection of webhook-delivery-attempt resources.",
"allOf": [
{
"$ref": "#/components/schemas/webhook-delivery-attempts.read"
}
]
},
"examples": {
"attempts": {
"$ref": "#/components/examples/webhook-delivery-attempts.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/webhooks/get-webhook-delivery-attempts",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n webhook-deliveries.readonly\n```\nor \n```\n webhook-deliveries.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "List webhook-delivery-attempts"
}
}
}
},
"/lucca-api/webhook-delivery-attempts/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/api-version"
},
{
"$ref": "#/components/parameters/if-none-match"
},
{
"$ref": "#/components/parameters/if-match"
},
{
"$ref": "#/components/parameters/include"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"name": "id",
"in": "path",
"required": true,
"description": "ID of the webhook-delivery-attempt.",
"schema": {
"type": "string",
"minLength": 1
}
}
],
"get": {
"x-beta": true,
"operationId": "get-webhook-delivery-attempt",
"summary": "Retrieve a webhook-delivery-attempt",
"description": "Retrieve a webhook-delivery-attempt.",
"tags": [
"webhooks"
],
"security": [
{
"oAuth": [
"webhook-deliveries.readonly"
]
},
{
"oAuth": [
"webhook-deliveries.readwrite"
]
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Content-Encoding": {
"$ref": "#/components/headers/content-encoding"
},
"ETag": {
"$ref": "#/components/headers/eTag"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"unevaluatedProperties": false,
"description": "A webhook-delivery-attempt resource.",
"allOf": [
{
"$ref": "#/components/schemas/webhook-delivery-attempt.read"
}
]
},
"examples": {
"attempt": {
"$ref": "#/components/examples/webhook-delivery-attempt.get.example"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/500"
}
},
"x-mint": {
"href": "/api-reference/latest/webhooks/get-webhook-delivery-attempt",
"content": "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](/documentation/using-api/versioning). \n\n\n**OAuth 2.0 scopes**\n\n```\n webhook-deliveries.readonly\n```\nor \n```\n webhook-deliveries.readwrite\n```\n",
"metadata": {
"tag": "beta",
"sidebarTitle": "Retrieve a webhook-delivery-attempt"
}
}
}
}
},
"components": {
"securitySchemes": {
"oAuth": {
"type": "oauth2",
"description": "The Lucca API implements the [oAuth 2](https://oauth.net/2/) protocol with the [client-credentials-flow](https://auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow). Refer to RFC8725.",
"flows": {
"clientCredentials": {
"tokenUrl": "https://accounts.world.luccasoftware.com/connect/token",
"scopes": {
"legal-entities.readonly": "Read [legal-entities](/api-reference/2024-11-01/organization/legal-entity).",
"legal-entities.readwrite": "Create, update or delete [legal-entities](/api-reference/2024-11-01/organization/legal-entity).",
"business-establishments.readonly": "Read [business-establishments](/api-reference/2024-11-01/organization/business-establishment).",
"business-establishments.readwrite": "Create, update or delete [business-establishments](/api-reference/2024-11-01/organization/business-establishment).",
"departments.readonly": "Read [departments](/api-reference/2024-11-01/organization/department).",
"departments.readwrite": "Create, update or delete [departments](/api-reference/2024-11-01/organization/department).",
"employees.readonly": "Read [employees](/api-reference/2024-11-01/employees/employee).",
"employees.readwrite": "Create or update [employees](/api-reference/2024-11-01/employees/employee).",
"employee-attribute-definitions.readonly": "Read [employee-attribute-definitions](/api-reference/2024-11-01/employee-attributes/employee-attribute-definition).",
"employee-attribute-definitions.readwrite": "Create, update or delete [employee-attribute-definitions](/api-reference/2024-11-01/employee-attributes/employee-attribute-definition)\nand [taxonomies](/api-reference/2024-11-01/taxonomies/taxonomy).",
"employee-attributes.readonly": "Read [employee-attributes](/api-reference/2024-11-01/employee-attributes/employee-attribute).",
"employee-attributes.readwrite": "Create, update or delete [employee-attributes](/api-reference/2024-11-01/employee-attributes/employee-attribute).",
"employee-personal-records.readonly": "Read [employee-personal-records](/api-reference/2024-11-01/employees/employee-personal-record).\nThis contains highly sensitive data about the personal detail of the person.",
"employee-personal-records.readwrite": "Create, update or delete [employee-personal-records](/api-reference/2024-11-01/employees/employee-personal-record).\nThis contains highly sensitive data about the personal detail of the person.",
"employments.readonly": "Read [employments](/api-reference/2024-11-01/employments/employment).",
"employments.readwrite": "Create, update or delete [employments](/api-reference/2024-11-01/employments/employment).",
"employment-templates.readonly": "Read [employment-templates](/api-reference/2024-11-01/employments/employment-template).",
"employment-templates.readwrite": "Create, update or archive [employment-templates](/api-reference/2024-11-01/employments/employment-template).",
"job-positions.readonly": "Read [job-positions](/api-reference/2024-11-01/employments/job-position).",
"job-positions.readwrite": "Create, update or delete [job-positions](/api-reference/2024-11-01/employments/job-position).",
"probationary-periods.readonly": "Read [probationary-periods](/api-reference/2024-11-01/employments/probationary-period).",
"probationary-periods.readwrite": "Create, update or delete [probationary-periods](/api-reference/2024-11-01/employments/probationary-period).",
"occupation-categories.readonly": "Read [occupation-categories](/api-reference/2024-11-01/employee-occupation-categories/occupation-category).",
"occupation-categories.readwrite": "Create, update or delete [occupation-categories](/api-reference/2024-11-01/employee-occupation-categories/occupation-category).",
"job-qualifications.readonly": "Read [job-qualifications](/api-reference/2024-11-01/employee-job-qualifications/job-qualification) and [professions](/api-reference/2024-11-01/employee-job-qualifications/profession).",
"job-qualifications.readwrite": "Create, update or delete [job-qualifications](/api-reference/2024-11-01/employee-job-qualifications/job-qualification) and [professions](/api-reference/2024-11-01/employee-job-qualifications/profession).",
"taxonomies.readonly": "Read [taxonomies](/api-reference/2024-11-01/taxonomies/taxonomy) and [taxonomy-labels](/api-reference/2024-11-01/taxonomies/taxonomy-label).",
"taxonomies.readwrite": "Create, update or delete [taxonomies](/api-reference/2024-11-01/taxonomies/taxonomy) and [taxonomy-labels](/api-reference/2024-11-01/taxonomies/taxonomy-label).",
"webhook-endpoints.readonly": "Read webhook-endpoints.",
"webhook-endpoints.readwrite": "Create and update webhook-endpoints.",
"webhook-deliveries.readonly": "Read webhook-deliveries.",
"webhook-deliveries.readwrite": "Send a ping event to a webhook-endpoint.",
"events.readonly": "Read [events](/api-reference/2024-11-01/events/event).\nOnly events of resources covered by the client's other scopes are returned (see [access control](/api-reference/2024-11-01/events/access-control)).",
"working-time-arrangements.readonly": "Read working-time-arrangements.",
"files.readonly": "Read files stored in Lucca.",
"files.readwrite": "Upload a file to Lucca."
},
"x-scope-metadata": {
"legal-entities.readonly": {
"criticality": "low",
"resources": "[legal-entity](/api-reference/2024-11-01/organization/legal-entity)"
},
"legal-entities.readwrite": {
"criticality": "medium",
"resources": "[legal-entity](/api-reference/2024-11-01/organization/legal-entity)"
},
"business-establishments.readonly": {
"criticality": "low",
"resources": "[business-establishment](/api-reference/2024-11-01/organization/business-establishment)"
},
"business-establishments.readwrite": {
"criticality": "medium",
"resources": "[business-establishment](/api-reference/2024-11-01/organization/business-establishment)"
},
"departments.readonly": {
"criticality": "low",
"resources": "[department](/api-reference/2024-11-01/organization/department)"
},
"departments.readwrite": {
"criticality": "medium",
"resources": "[department](/api-reference/2024-11-01/organization/department)"
},
"employees.readonly": {
"criticality": "medium",
"resources": "[employee](/api-reference/2024-11-01/employees/employee)"
},
"employees.readwrite": {
"criticality": "medium",
"resources": "[employee](/api-reference/2024-11-01/employees/employee)"
},
"employee-attribute-definitions.readonly": {
"criticality": "low",
"resources": "[employee-attribute-definition](/api-reference/2024-11-01/employee-attributes/employee-attribute-definition)"
},
"employee-attribute-definitions.readwrite": {
"criticality": "medium",
"resources": "[employee-attribute-definition](/api-reference/2024-11-01/employee-attributes/employee-attribute-definition), [taxonomy](/api-reference/2024-11-01/taxonomies/taxonomy)"
},
"employee-attributes.readonly": {
"criticality": "medium",
"resources": "[employee-attribute](/api-reference/2024-11-01/employee-attributes/employee-attribute)"
},
"employee-attributes.readwrite": {
"criticality": "medium",
"resources": "[employee-attribute](/api-reference/2024-11-01/employee-attributes/employee-attribute)"
},
"employee-personal-records.readonly": {
"criticality": "high",
"resources": "[employee-personal-record](/api-reference/2024-11-01/employees/employee-personal-record)"
},
"employee-personal-records.readwrite": {
"criticality": "high",
"resources": "[employee-personal-record](/api-reference/2024-11-01/employees/employee-personal-record)"
},
"employments.readonly": {
"criticality": "medium",
"resources": "[employment](/api-reference/2024-11-01/employments/employment)"
},
"employments.readwrite": {
"criticality": "medium",
"resources": "[employment](/api-reference/2024-11-01/employments/employment)"
},
"employment-templates.readonly": {
"criticality": "medium",
"resources": "[employment-template](/api-reference/2024-11-01/employments/employment-template)"
},
"employment-templates.readwrite": {
"criticality": "medium",
"resources": "[employment-template](/api-reference/2024-11-01/employments/employment-template)"
},
"job-positions.readonly": {
"criticality": "low",
"resources": "[job-position](/api-reference/2024-11-01/employments/job-position)"
},
"job-positions.readwrite": {
"criticality": "medium",
"resources": "[job-position](/api-reference/2024-11-01/employments/job-position)"
},
"probationary-periods.readonly": {
"criticality": "medium",
"resources": "[probationary-period](/api-reference/2024-11-01/employments/probationary-period)"
},
"probationary-periods.readwrite": {
"criticality": "medium",
"resources": "[probationary-period](/api-reference/2024-11-01/employments/probationary-period)"
},
"occupation-categories.readonly": {
"criticality": "low",
"resources": "[occupation-category](/api-reference/2024-11-01/employee-occupation-categories/get-started)"
},
"occupation-categories.readwrite": {
"criticality": "medium",
"resources": "[occupation-category](/api-reference/2024-11-01/employee-occupation-categories/get-started)"
},
"job-qualifications.readonly": {
"criticality": "low",
"resources": "[job-qualification](/api-reference/2024-11-01/employee-job-qualifications/job-qualification) and [professions](/api-reference/2024-11-01/employee-job-qualifications/profession)"
},
"job-qualifications.readwrite": {
"criticality": "medium",
"resources": "[job-qualification](/api-reference/2024-11-01/employee-job-qualifications/job-qualification) and [professions](/api-reference/2024-11-01/employee-job-qualifications/profession)"
},
"taxonomies.readonly": {
"criticality": "low",
"resources": "[taxonomy](/api-reference/2024-11-01/taxonomies/taxonomy) & [taxonomy-label](/api-reference/2024-11-01/taxonomies/taxonomy-label)"
},
"taxonomies.readwrite": {
"criticality": "medium",
"resources": "[taxonomy](/api-reference/2024-11-01/taxonomies/taxonomy) & [taxonomy-label](/api-reference/2024-11-01/taxonomies/taxonomy-label)"
},
"webhook-endpoints.readonly": {
"criticality": "low",
"resources": "[webhook-endpoint](/api-reference/2024-11-01/webhooks/webhook-endpoint)"
},
"webhook-endpoints.readwrite": {
"criticality": "medium",
"resources": "[webhook-endpoint](/api-reference/2024-11-01/webhooks/webhook-endpoint)"
},
"webhook-deliveries.readonly": {
"criticality": "low",
"resources": "[webhook-delivery](/api-reference/2024-11-01/webhooks/webhook-delivery) & [webhook-delivery-attempt](/api-reference/2024-11-01/webhooks/webhook-delivery-attempt)"
},
"webhook-deliveries.readwrite": {
"criticality": "medium",
"resources": "[webhook-delivery](/api-reference/2024-11-01/webhooks/webhook-delivery) & [webhook-delivery-attempt](/api-reference/2024-11-01/webhooks/webhook-delivery-attempt)"
},
"events.readonly": {
"criticality": "medium",
"resources": "[event](/api-reference/2024-11-01/events/event)"
},
"working-time-arrangements.readonly": {
"criticality": "low",
"resources": "[working-time-arrangement](/api-reference/2024-11-01/working-time-arrangements/working-time-arrangement)"
},
"files.readonly": {
"criticality": "medium",
"resources": "[file](/api-reference/2024-11-01/files/file)"
},
"files.readwrite": {
"criticality": "medium",
"resources": "[file](/api-reference/2024-11-01/files/file)"
}
}
}
}
}
},
"parameters": {
"api-version": {
"name": "Api-Version",
"in": "header",
"description": "Set the [API version](/documentation/using-api/versioning).",
"schema": {
"type": "string",
"format": "date",
"const": "2024-11-01",
"enum": [
"2024-11-01"
],
"maxLength": 10,
"examples": [
"2024-11-01"
]
},
"required": true
},
"if-none-match": {
"name": "If-None-Match",
"in": "header",
"description": "Only execute the request if current cached version of the resource does not match the one given here.",
"schema": {
"type": "string",
"examples": [
"W/q5sd4w2x1c1gfdg"
]
},
"required": false
},
"if-match": {
"name": "If-Match",
"in": "header",
"description": "Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.",
"schema": {
"type": "string",
"examples": [
"W/q5sd4w2x1c1gfdg"
]
},
"required": false
},
"accept-encoding": {
"name": "Accept-Encoding",
"description": "List of compression algorithms you support.",
"in": "header",
"schema": {
"type": "string"
},
"examples": {
"unWeighted": {
"value": "gzip, compress, br"
},
"weighted": {
"value": "gzip;q=1.0, identity; q=0.5, *;q=0"
}
}
},
"include": {
"description": "Include metadata:\n - `embedded`: the partial or complete representations of related resources \n (e.g. the employee the resource belongs to).\n - `links`: links to related resources or actions (e.g. approving a leave-request).\n May be `null` when you do not have access to the resource (or action).\n Includes the download links of the files the resource references, under `links.files`.\n - `totalCount`: only applicable on collections (i.e. lists of resources), gives\n the total number of items across all pages.\n\nRead more about [expanding responses](/documentation/using-api/includes).",
"name": "include",
"in": "query",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"embedded",
"links",
"totalCount"
],
"x-enumDescriptions": {
"embedded": "Partial or complete representations of related resources (e.g. the employee the resource belongs to).",
"links": "Link resources to related resources or actions (e.g. approving a leave-request).\nMay be `null` when you do not have access to the resource (or action).\nIncludes the download links of the files the resource references, under `links.files`.",
"totalCount": "Is only applicable on collections (i.e. lists of resources), gives the total number of items across all pages."
}
}
}
},
"is-archived": {
"name": "isArchived",
"description": "When omitted: return both archived and non-archived resources.\nWhen `true`: only return archived resources.\nWhen `false`: only return non-archived resources.",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
},
"examples": {
"onlyArchived": {
"value": true
}
}
},
"page": {
"name": "page",
"in": "query",
"description": "Cursor of the page to retrieve: `links.next.cursor` or `links.prev.cursor` of a previous response, which is also the `page` value of their `href`.\nCursors are opaque: don't build or modify them. An invalid cursor gets a `400 Bad Request`.\nRead more about [pagination](/documentation/using-api/paging).",
"schema": {
"type": "string"
},
"examples": {
"one": {
"summary": "Cursor read from `links.next.cursor` (opaque)",
"value": "!w.SDijk23"
}
}
},
"limit": {
"name": "limit",
"in": "query",
"description": "Number of items per page. Defaults to 25. Maximum is 100.\nRead more about [pagination](/documentation/using-api/paging).",
"schema": {
"type": "integer",
"default": 25,
"minimum": 0,
"maximum": 100
},
"examples": {
"one": {
"summary": "Retrieve 25 items.",
"value": 25
}
}
},
"limit1000": {
"name": "limit",
"in": "query",
"description": "Number of items per page. Defaults to 25. Maximum is 1,000.\nRead more about [pagination](/documentation/using-api/paging).",
"schema": {
"type": "integer",
"default": 25,
"minimum": 0,
"maximum": 1000
},
"examples": {
"one": {
"summary": "Retrieve 25 items.",
"value": 25
}
}
},
"schema.title": {
"name": "schema.title",
"description": "Filter out extension-definition on their schema.",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"short-text",
"long-text",
"boolean",
"int32",
"decimal",
"legacy-date",
"phone-number",
"email",
"url",
"file-reference",
"employee-reference",
"taxonomy-label-reference"
]
}
},
"limit.default20": {
"name": "limit",
"in": "query",
"description": "Number of items per page. Defaults to 20. Maximum is 100.\nRead more about [pagination](/documentation/using-api/paging).",
"schema": {
"type": "integer",
"default": 20,
"minimum": 0,
"maximum": 100
},
"examples": {
"one": {
"summary": "Retrieve 20 items.",
"value": 20
}
}
}
},
"headers": {
"api-version": {
"description": "Name (date of release) of the API version.",
"schema": {
"type": "string",
"const": "2024-11-01",
"examples": [
"2024-11-01"
],
"maxLength": 10
},
"required": true
},
"content-encoding": {
"description": "HTTP representation header that lists the encodings and the order in which they have been applied to the representation of the resource.",
"required": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"gzip",
"compress",
"deflate",
"br"
]
}
},
"examples": {
"gzip": {
"value": [
"gzip"
]
}
}
},
"location": {
"schema": {
"type": "string",
"format": "uri"
},
"description": "URL to the resource. Most often, the created resource from a POST request made to a collection path, e.g. `POST /lucca-api/employees`."
},
"eTag": {
"description": "Identifies the cached version of the resource.",
"schema": {
"type": "string",
"examples": [
"W/q5sd4w2x1c1gfdg"
]
}
},
"deprecation": {
"description": "Signals the resource has been deprecated.\n",
"schema": {
"type": "string",
"format": "date",
"maxLength": 10,
"examples": [
"2024-01-01"
]
}
},
"sunset": {
"description": "The **Sunset** response header (see [RFC 8594](https://datatracker.ietf.org/doc/html/rfc8594)) indicates the point in time at which this endpoint or resource will become unavailable. The sunset value is a timestamp [RFC 9110 Section 5.6.7][rfc-9110-5.6.7] that usually points to the future. If a sunset value points to the past, then the endpooint or resource must be expected to become unavailable at any time.\nAs an API client, you should monitor the presence and value of all **Sunset** headers and be ready to take counter measures.\n",
"schema": {
"type": "string",
"format": "date-time",
"examples": [
"2026-01-01T00:00:00Z"
]
}
}
},
"schemas": {
"t9n": {
"type": [
"object",
"null"
],
"title": "Translations",
"description": "Used for translation purposes. Object is structured as a dictionary whose keys refer to translated properties of the parent object, and whose values are a dictionary of supported languages.\n\nOn the parent object, the translated property value is considered the \"invariant\" translation. It is expected to show this value whenever the user's language has no translation in `t9n`.\n\nLanguages are identified through their RFC 4646 language tag.",
"properties": {
"de-DE": {
"description": "German (Germany)",
"type": [
"string",
"null"
]
},
"en-US": {
"description": "English (United States of America)",
"type": [
"string",
"null"
]
},
"en-GB": {
"description": "English (Great Britain)",
"type": [
"string",
"null"
]
},
"es-ES": {
"description": "Spanish (Spain)",
"type": [
"string",
"null"
]
},
"fr-FR": {
"description": "French (France)",
"type": [
"string",
"null"
]
},
"fr-CH": {
"description": "French (Switzerland)",
"type": [
"string",
"null"
]
},
"it-IT": {
"description": "Italian (Italy)",
"type": [
"string",
"null"
]
},
"nl-BE": {
"description": "Dutch (Belgium)",
"type": [
"string",
"null"
]
},
"nl-NL": {
"description": "Dutch (Netherlands)",
"type": [
"string",
"null"
]
},
"pt-PT": {
"description": "Portuguese (Portugal)",
"type": [
"string",
"null"
]
}
}
},
"problem": {
"title": "Problem",
"description": "Represents a \"problem detail\" as a way to carry machine-readable details of errors in a HTTP response.",
"type": "object",
"additionalProperties": true,
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "Identifies the problem type. Points to a page containing a human-readable documentation for the problem type.",
"example": "https://tools.ietf.org/html/rfc7231#section-6.5.1"
},
"title": {
"type": [
"string",
"null"
],
"description": "A short, summary of the problem type (e.g.: Service Unavailable)",
"example": "Bad Request"
},
"status": {
"description": "The HTTP status code generated by the origin server for this occurrence of the problem.",
"type": [
"integer",
"null"
],
"format": "int32",
"minimum": 100,
"maximum": 599,
"example": 400
},
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem.",
"type": [
"string",
"null"
],
"example": "One or more validation errors occurred."
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"example": {
"startsOn": [
"Invalid period: startsOn should be before endsOn."
]
}
},
"t9n": {
"description": "Translations of the problem. `t9n.detail` holds the translations of `detail`, indexed by language.",
"type": "object",
"properties": {
"detail": {
"$ref": "#/components/schemas/t9n"
}
}
}
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "Bad Request",
"detail": "One or more validation errors occurred.",
"status": 400,
"errors": {
"startsOn": [
"Invalid period: startsOn should be before endsOn."
]
},
"t9n": {
"detail": {
"fr-FR": "Une (au moins) erreur de validation a été rencontrée."
}
}
}
},
"createdAt": {
"title": "createdAt",
"description": "**Read-only.** UTC timestamp of the moment this object was created.\nThe UTC offset may be written `Z` or `+00:00`, with up to 7 fractional digits of a second.",
"type": "string",
"format": "date-time",
"examples": [
"2023-01-23T12:45:23.1234567+00:00",
"2023-01-23T12:45:23.1234Z"
]
},
"file": {
"title": "file",
"description": "JSON representation of a file. A file may be downloaded via the `Accept: octet-stream` HTTP header.",
"type": "object",
"x-tags": [
"files"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "file"
},
"url": {
"type": "string",
"format": "uri"
},
"fileName": {
"type": "string",
"minLength": 1
},
"contentType": {
"type": "string",
"description": "Indicates the content-type of the file. Refer to the enum values to figure out which are accepted.",
"enum": [
"message/rfc822",
"binary/octet-stream",
"unknown/unknown",
"audio/mpeg",
"video/mp4",
"image/png",
"image/heic",
"image/heif",
"image/jpe",
"image/jpg",
"image/pjpeg",
"image/gif",
"image/bmp",
"image/tif",
"image/tiff",
"image/x-dcraw",
"image/x-jb2",
"image/x-jbig2",
"image/x-jpf",
"image/x-ms-bmp",
"image/x-panasonic-raw",
"image/x-pcx",
"image/x-icon",
"image/x-png",
"image/vnd.microsoft.icon",
"image/webp",
"image/svg+xml",
"image/x-portable-anymap",
"text/plain",
"text/csv",
"text/rtf",
"text/calendar",
"text/comma-separated-values",
"text/css",
"text/html",
"text/xml",
"text/markdown",
"text/x-affix",
"application/pdf",
"application/msword",
"application/xls",
"application/x-csv",
"application/ms-excel",
"application/vnd.ms-office",
"application/vnd.ms-word",
"application/vnd.ms-outlook",
"application/vnd.ms-powerpoint",
"application/vnd.ms-excel",
"application/vnd.ms-excel.sheet.binary.macroEnabled.12",
"application/vnd.ms-excel.sheet.macroEnabled.12",
"application/vnd.ms-pki.stl",
"application/vnd.ms-xpsdocument",
"application/vnd.oasis.opendocument.text",
"application/vnd.oasis.opendocument.spreadsheet",
"application/vnd.oasis.opendocument.presentation",
"application/vnd.oasis.opendocument.graphics",
"application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
"application/vnd.openxmlformats-officedocument.presentationml.presentation",
"application/vnd.openxmlformats-officedocument.presentationml.slideshow",
"application/vnd.openxmlformats-officedocument.presentationml.template",
"application/x-7z-compressed",
"application/rar",
"application/x-rar",
"application/zip",
"application/andrew-inset",
"application/binary",
"application/csv",
"application/download",
"application/force-download",
"application/x-download",
"application/hta",
"application/javascript",
"application/json",
"application/mac-binhex40",
"application/oleobject",
"application/pkcs7-signature",
"application/postscript",
"application/rtf",
"application/text",
"application/txt",
"application/unknown",
"application/x-iwork-keynote-sffkey",
"application/x-ms-application",
"application/x-ms-manifest",
"application/x-msdownload",
"application/x-pdf",
"application/x-unknown",
"application/x-zip-compressed",
"application/xml",
"application/x-wine-extension-ini",
"application/vnd.hp-hpgl",
"application/x-sega-pico-rom"
]
},
"createdAt": {
"$ref": "#/components/schemas/createdAt"
},
"links": {
"type": [
"null",
"object"
],
"additionalProperties": false
}
},
"example": {
"id": "2face165-5345-4cf3-ab05-5421a6b19df2",
"type": "file",
"url": "https://example.ilucca.net/lucca-api/files/2face165-5345-4cf3-ab05-5421a6b19df2",
"fileName": "pic.jpg",
"contentType": "image/jpg",
"createdAt": "2024-01-15T08:30:00Z",
"links": {}
}
},
"file.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "No embedded resources on a file response. Expect an empty object if embedded are requested.",
"type": [
"object",
"null"
]
}
}
},
"file.read": {
"allOf": [
{
"$ref": "#/components/schemas/file"
},
{
"$ref": "#/components/schemas/file.embedded"
}
]
},
"country-code": {
"title": "Country Code",
"description": "Three letters ISO 3166-1 alpha-3 country code. Lucca uses [restcountries.com](https://restcountries.com/) to map these codes to the country names displayed in the UI.",
"type": "string",
"minLength": 3,
"maxLength": 3,
"enum": [
"FRA",
"ESP",
"DEU",
"CHE",
"ITA",
"GBR",
"USA",
"BEL",
"CAN",
"AFG",
"ALA",
"ALB",
"DZA",
"ASM",
"AND",
"AGO",
"AIA",
"ATA",
"ATG",
"ARG",
"ARM",
"ABW",
"AUS",
"AUT",
"AZE",
"BHS",
"BHR",
"BGD",
"BRB",
"BLR",
"BLZ",
"BEN",
"BMU",
"BTN",
"BOL",
"BIH",
"BWA",
"BVT",
"BRA",
"VGB",
"IOT",
"BRN",
"BGR",
"BFA",
"BDI",
"KHM",
"CMR",
"CPV",
"CYM",
"CAF",
"TCD",
"CHL",
"CHN",
"HKG",
"MAC",
"CXR",
"CCK",
"COL",
"COM",
"COG",
"COD",
"COK",
"CRI",
"CIV",
"HRV",
"CUB",
"CYP",
"CZE",
"DNK",
"DJI",
"DMA",
"DOM",
"ECU",
"EGY",
"SLV",
"GNQ",
"ERI",
"EST",
"ETH",
"FLK",
"FRO",
"FJI",
"FIN",
"GUF",
"PYF",
"ATF",
"GAB",
"GMB",
"GEO",
"GHA",
"GIB",
"GRC",
"GRL",
"GRD",
"GLP",
"GUM",
"GTM",
"GGY",
"GIN",
"GNB",
"GUY",
"HTI",
"HMD",
"VAT",
"HND",
"HUN",
"ISL",
"IND",
"IDN",
"IRN",
"IRQ",
"IRL",
"IMN",
"ISR",
"JAM",
"JPN",
"JEY",
"JOR",
"KAZ",
"KEN",
"KIR",
"PRK",
"KOR",
"KWT",
"KGZ",
"LAO",
"LVA",
"LBN",
"LSO",
"LBR",
"LBY",
"LIE",
"LTU",
"LUX",
"MKD",
"MDG",
"MWI",
"MYS",
"MDV",
"MLI",
"MLT",
"MHL",
"MTQ",
"MRT",
"MUS",
"MYT",
"MEX",
"FSM",
"MDA",
"MCO",
"MNG",
"MNE",
"MSR",
"MAR",
"MOZ",
"MMR",
"NAM",
"NRU",
"NPL",
"NLD",
"NCL",
"NZL",
"NIC",
"NER",
"NGA",
"NIU",
"NFK",
"MNP",
"NOR",
"OMN",
"PAK",
"PLW",
"PSE",
"PAN",
"PNG",
"PRY",
"PER",
"PHL",
"PCN",
"POL",
"PRT",
"PRI",
"QAT",
"REU",
"ROU",
"RUS",
"RWA",
"BLM",
"SHN",
"KNA",
"LCA",
"MAF",
"SXM",
"SPM",
"VCT",
"WSM",
"SMR",
"STP",
"SAU",
"SEN",
"SRB",
"SYC",
"SLE",
"SGP",
"SVK",
"SVN",
"SLB",
"SOM",
"ZAF",
"SGS",
"SSD",
"LKA",
"SDN",
"SUR",
"SJM",
"SWZ",
"SWE",
"SYR",
"TWN",
"TJK",
"TZA",
"THA",
"TLS",
"TGO",
"TKL",
"TON",
"TTO",
"TUN",
"TUR",
"TKM",
"TCA",
"TUV",
"UGA",
"UKR",
"ARE",
"UMI",
"URY",
"UZB",
"VUT",
"VEN",
"VNM",
"VIR",
"WLF",
"ESH",
"YEM",
"ZMB",
"ZWE"
],
"examples": [
"FRA",
"DEU"
]
},
"currency-code": {
"title": "iso-4217 currency code",
"description": "ISO-4217 currency code",
"type": "string",
"enum": [
"EUR",
"CHF",
"GBP",
"USD",
"CAD",
"JPY",
"BBD",
"XAF",
"AUD",
"PLN",
"STN",
"NOK",
"XBA",
"XBB",
"ADP",
"GWP",
"ITL",
"IEP",
"ILR",
"LUC",
"LUL",
"ROL",
"RUR",
"VEF",
"ZWN",
"DKK",
"PEN",
"XCD",
"XSU",
"TND",
"VUV",
"PEI",
"PLZ",
"ESA",
"BOB",
"KPW",
"MGA",
"OMR",
"RWF",
"SLL",
"SGD",
"XPF",
"RON",
"ZAL",
"ESP",
"VEB",
"VNC",
"BTN",
"CNY",
"SVC",
"HKD",
"LSL",
"MUR",
"ZAR",
"NZD",
"XAU",
"HRK",
"LAJ",
"BGN",
"GEL",
"KES",
"MNT",
"SHP",
"UAH",
"YUD",
"DJF",
"GTQ",
"ANG",
"BUK",
"FRF",
"MXP",
"NLG",
"UGW",
"YUN",
"BHD",
"CLF",
"ERN",
"GYD",
"PAB",
"XOF",
"XTS",
"ARP",
"LTT",
"MZM",
"PTE",
"CSD",
"ZMK",
"BZD",
"FKP",
"MXV",
"SBD",
"CHW",
"TWD",
"TTD",
"TRY",
"UYU",
"BEC",
"BEL",
"GRD",
"IDR",
"ZRZ",
"BYN",
"ISK",
"LRD",
"ARA",
"DDM",
"GHC",
"SDP",
"UAK",
"BSD",
"LAK",
"MDL",
"MZN",
"SSP",
"UYI",
"BYR",
"CSJ",
"GWE",
"LUF",
"HTG",
"KRW",
"QAR",
"NIC",
"SIT",
"SDG",
"CHC",
"AOA",
"PHP",
"WST",
"BAD",
"BRN",
"BRR",
"CYP",
"GNS",
"LTL",
"MTP",
"UYN",
"DZD",
"AWG",
"KYD",
"SYP",
"TZS",
"FIM",
"MVQ",
"SUR",
"USS",
"ZRN",
"KHR",
"CRC",
"INR",
"NIO",
"LKR",
"SRD",
"UYW",
"XAG",
"DEM",
"XFU",
"CVE",
"CLP",
"CDF",
"CUC",
"CHE",
"XBD",
"ALK",
"BGK",
"EEK",
"GEK",
"LVR",
"TRL",
"AZN",
"CZK",
"UGX",
"USN",
"XPT",
"BRB",
"BGL",
"LSM",
"PEH",
"UYP",
"XRE",
"BMD",
"BOV",
"BWP",
"BIF",
"DOP",
"KZT",
"RSD",
"ZMW",
"BEF",
"BRC",
"CSK",
"GQE",
"GHP",
"ISJ",
"LVL",
"TPE",
"UGS",
"XFO",
"MVR",
"PGK",
"AED",
"UZS",
"AYM",
"BOP",
"BGJ",
"SKK",
"AFN",
"KMF",
"GMD",
"IRR",
"ILS",
"KGS",
"NPR",
"SAR",
"VES",
"XXX",
"HRD",
"ROK",
"ALL",
"GNF",
"JOD",
"MWK",
"SEK",
"XPD",
"BRE",
"ECV",
"STD",
"TMM",
"CUP",
"MAD",
"NGN",
"AFA",
"ECS",
"PES",
"COU",
"KWD",
"LBP",
"ATS",
"BYB",
"ZWD",
"AMD",
"GIP",
"MKD",
"MYR",
"MXN",
"RUB",
"THB",
"TOP",
"TMT",
"ARY",
"XEU",
"ARS",
"ETB",
"XDR",
"IQD",
"XUA",
"NAD",
"PKR",
"TJS",
"YER",
"ZWL",
"AOK",
"RHD",
"YUM",
"BND",
"GHS",
"SOS",
"ZWR",
"BAM",
"COP",
"HUF",
"JMD",
"LYD",
"XBC",
"MLF",
"SDD",
"ZWC",
"EGP",
"SZL",
"MOP",
"MMK",
"VND",
"AON",
"MTL",
"MRO",
"MZE",
"SRG",
"YDD",
"BDT",
"BRL",
"FJD",
"HNL",
"MRU",
"PYG",
"SCR",
"AOR",
"AZM",
"GNE",
"ILP",
"MGF",
"ESB",
"TJR"
]
},
"lastUpdatedAt": {
"title": "lastUpdatedAt",
"description": "**Read-only.** UTC timestamp of the moment this object was last updated.\nSet upon creation, update or deletion of the object.\nThe UTC offset may be written `Z` or `+00:00`, with up to 7 fractional digits of a second.",
"type": "string",
"format": "date-time",
"examples": [
"2023-01-23T12:45:23.1234567+00:00",
"2023-01-23T12:45:23.1234Z"
]
},
"lastArchivedAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "**Read-only.** UTC timestamp of the moment this object was last archived through its `isArchived` property.\nThe 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"
]
},
"link": {
"title": "Link",
"description": "Object that represents an hyperlink.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"href": {
"type": "string",
"format": "uri",
"description": "URL to the related object."
}
},
"required": [
"href"
]
},
"legal-entity": {
"title": "legal-entity",
"description": "Representation of a legal entity, i.e. an organization that is subject to legal responsibilities in a given jurisdiction (country).\n\nA legal-entity may be comprised of several [business-establishments](/api-reference/2024-11-01/organization/business-establishment) which represent geographically localized structures where the actual work is done. One of which is marked as the legal-entity headquarters.",
"x-tags": [
"organization"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "legal-entity"
},
"url": {
"type": "string",
"format": "uri"
},
"legalName": {
"description": "**Must be unique**. Legal name of the legal-entity.",
"type": "string",
"minLength": 1,
"maxLength": 255
},
"remoteId": {
"type": [
"null",
"string"
],
"minLength": 1,
"maxLength": 50,
"description": "The third-party API ID of the matching object."
},
"isArchived": {
"description": "If this legal-entity is archived. Only possible if there are no more business-establishment attached.",
"type": "boolean"
},
"countryCode": {
"$ref": "#/components/schemas/country-code"
},
"currencyCode": {
"$ref": "#/components/schemas/currency-code"
},
"taxIdentificationNumber": {
"description": "Identifier of the legal-entity in its local jurisdiction.\n- France: SIREN (Système d'identification du répertoire des entreprises)\n- Germany: SN (Steuernummer).\n- Spain: N.I.F (Número de Identificación Fiscal)",
"type": [
"null",
"object"
],
"additionalProperties": false,
"required": [
"format",
"value"
],
"properties": {
"format": {
"type": "string",
"enum": [
"other",
"franceSIREN",
"spainNIF",
"germanySN"
]
},
"value": {
"type": "string",
"minLength": 1
}
}
},
"industryCode": {
"description": "The industry (classification) code identifies the main type of activity of this legal-entity.\n- France: APE or NAF code.\n- Spain: CNAE.\n- Germany: WZ (Die Klassifikation der Wirtschaftszweige).\n- U.S.A.: NAICS (North American Industry Classification System).",
"type": [
"null",
"object"
],
"additionalProperties": false,
"required": [
"format",
"value"
],
"properties": {
"format": {
"type": "string",
"enum": [
"other",
"franceAPE",
"spainCNAE",
"germanyWZ",
"usaNAICS"
]
},
"value": {
"type": "string",
"minLength": 1
}
}
},
"createdAt": {
"$ref": "#/components/schemas/createdAt"
},
"lastUpdatedAt": {
"$ref": "#/components/schemas/lastUpdatedAt"
},
"lastArchivedAt": {
"$ref": "#/components/schemas/lastArchivedAt"
},
"links": {
"type": "object",
"additionalProperties": false,
"properties": {
"businessEstablishments": {
"$ref": "#/components/schemas/link"
}
}
}
},
"example": {
"id": "123",
"type": "legal-entity",
"url": "https://example.ilucca.net/lucca-api/legal-entities/123",
"legalName": "Lucca S.A.S.",
"remoteId": "LE:83.2938",
"isArchived": false,
"countryCode": "FRA",
"currencyCode": "EUR",
"taxIdentificationNumber": {
"format": "franceSIREN",
"value": "44163769100128"
},
"industryCode": {
"format": "franceAPE",
"value": "7022Z"
},
"createdAt": "2024-01-01T08:34:23.0001Z",
"lastUpdatedAt": "2024-01-01T08:34:23.0001Z",
"lastArchivedAt": null,
"links": {
"businessEstablishments": {
"href": "https://example.ilucca.net/lucca-api/business-establishments?legalEntity.id=123"
}
}
}
},
"page-link": {
"title": "page-link",
"description": "Link to another page of a collection.\n\nFollow `href` as is, or call the same operation with `cursor` as its `page` query parameter, and the same other\nquery parameters as the current request (filters, `limit`, `include`).",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"href": {
"type": "string",
"format": "uri",
"description": "URL of the page."
},
"cursor": {
"type": "string",
"minLength": 1,
"examples": [
"!sdk87Sdh"
],
"description": "The `page` query parameter of `href`: an opaque cursor, exposed on its own so that clients and tools can\nrequest the page through the operation, without parsing `href`."
}
},
"required": [
"href",
"cursor"
]
},
"collection.links": {
"type": "object",
"properties": {
"links": {
"title": "Links",
"description": "Links to related resources",
"type": [
"object",
"null"
],
"required": [
"prev",
"next"
],
"properties": {
"prev": {
"description": "Link to the previous page, or `null` when there is none.\nIt may be set on the first page, and then leads to an empty page.",
"allOf": [
{
"$ref": "#/components/schemas/page-link"
}
]
},
"next": {
"description": "Link to the next page, or `null` when there is none: stop paging when `next` is `null`.\nIt may be set on the last page when that page is full, and then leads to an empty page whose `next` is `null`.",
"allOf": [
{
"$ref": "#/components/schemas/page-link"
}
]
}
}
}
}
},
"legal-entities": {
"title": "legal-entities",
"description": "Collection of legal-entity objects.",
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "legal-entities"
},
"url": {
"type": "string",
"format": "uri"
},
"totalCount": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0,
"description": "Total number of legal-entity resources across all pages that satisfy query parameters."
},
"items": {
"type": "array",
"minItems": 0,
"maxItems": 100,
"description": "Paginated list of legal-entity objects.",
"items": {
"$ref": "#/components/schemas/legal-entity"
}
}
}
},
{
"$ref": "#/components/schemas/collection.links"
}
]
},
"legal-entity.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "No embedded resources on a legal-entity(ies) response. Expect an empty object if embedded are requested.",
"type": [
"object",
"null"
]
}
}
},
"legal-entities.read": {
"allOf": [
{
"$ref": "#/components/schemas/legal-entities"
},
{
"$ref": "#/components/schemas/legal-entity.embedded"
}
]
},
"legal-entity.read": {
"allOf": [
{
"$ref": "#/components/schemas/legal-entity"
},
{
"$ref": "#/components/schemas/legal-entity.embedded"
}
]
},
"legal-entity-reference": {
"title": "Reference to a legal-entity",
"description": "Reference to a [legal-entity](/api-reference/2024-11-01/organization/legal-entity) resource.",
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "legal-entity",
"enum": [
"legal-entity"
],
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
}
}
},
"address": {
"title": "address",
"description": "Representation of a postal address.",
"type": "object",
"additionalProperties": false,
"properties": {
"addressLines": {
"description": "Unstructured ordered address lines describing the lower levels of an address.\nEmpty when the address has no lines.",
"type": "array",
"minItems": 0,
"items": {
"type": "string",
"minLength": 1
}
},
"postalCode": {
"description": "Optional. Postal code of the address. Not all countries use or require \npostal codes to be present, but where they are used, they may trigger \nadditional validation with other parts of the address \n(e.g. city validation).",
"type": [
"string",
"null"
]
},
"locality": {
"type": [
"string",
"null"
],
"description": "Optional. Generally refers to the city/town portion of the address. \nExamples: French city, IT comune, UK post town."
},
"administrativeArea": {
"description": "Optional. Highest administrative subdivision which is used for postal \naddresses of a country or region. For example, this can be a state, \na province, an oblast, or a prefecture.",
"type": [
"string",
"null"
]
},
"countryCode": {
"oneOf": [
{
"$ref": "#/components/schemas/country-code"
},
{
"type": "null"
}
]
}
},
"required": [
"addressLines"
],
"examples": [
{
"addressLines": [
"10 Place de la Joliette",
"Atrium 10.2"
],
"postalCode": "13002",
"locality": "Marseille",
"administrativeArea": "Bouches-du-Rhône",
"countryCode": "FRA"
}
]
},
"timezoneId": {
"title": "IANA timezone identifier",
"description": "Identifier from the [IANA timezone database](https://www.iana.org/time-zones).",
"type": "string",
"examples": [
"Europe/Paris"
]
},
"business-establishment": {
"title": "business-establishment",
"description": "A business-establishment is a geographically localized unit of the organization structure.\n\nIt belongs to a [legal-entity](/api-reference/2024-11-01/organization/legal-entity). A legal-entity may have one (and only one) business-establishment set as its headquarters.\n\nBusiness-establishments are an essential resource of the enterprise model, as they are the fundamental units of access rights scoping. As such, most objects are either directly or indirectly attached to a business-establishment.\n\nEmployees are attached to a business-establishment through their job-position.",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "business-establishment"
},
"url": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string",
"minLength": 1
},
"remoteId": {
"type": [
"null",
"string"
],
"description": "The third-party API ID of the matching object."
},
"isArchived": {
"description": "If this business-establishment is archived. Only possible if there are no more employees attached.",
"type": "boolean"
},
"legalEntity": {
"$ref": "#/components/schemas/legal-entity-reference",
"description": "Reference to the [legal-entity](/api-reference/2024-11-01/organization/legal-entity) this business-establishment belongs to."
},
"isHeadquarters": {
"description": "True when this business-establishment should be considered the headquarters of the legal-entity it belongs to.\nA legal-entity may only have a single one headquarters.",
"type": "boolean"
},
"taxIdentificationNumber": {
"description": "- France: SIRET (Système d'identification du répertoire des établissements). Must start with the same identifier than its legal-entity (SIREN).",
"type": [
"null",
"object"
],
"additionalProperties": false,
"required": [
"format",
"value"
],
"properties": {
"format": {
"type": "string",
"enum": [
"other",
"franceSIRET",
"spainNIF"
]
},
"value": {
"type": "string",
"minLength": 1
}
}
},
"industryCode": {
"description": "The industry (classification) code identifies the main type of activity of this legal-entity.\n- France: APE or NAF code.\n- Spain: CNAE.\n- Germany: WZ (Die Klassifikation der Wirtschaftszweige).\n- U.S.A.: NAICS (North American Industry Classification System).",
"type": [
"null",
"object"
],
"additionalProperties": false,
"required": [
"format",
"value"
],
"properties": {
"format": {
"type": "string",
"enum": [
"other",
"franceAPE",
"spainCNAE",
"germanyWZ",
"usaNAICS"
]
},
"value": {
"type": "string",
"minLength": 1
}
}
},
"address": {
"oneOf": [
{
"$ref": "#/components/schemas/address"
},
{
"type": "null"
}
]
},
"timezoneId": {
"description": "[IANA timezone identifier](https://www.iana.org/time-zones) this business-establishment belongs to.",
"oneOf": [
{
"$ref": "#/components/schemas/timezoneId"
},
{
"type": "null"
}
]
},
"lastArchivedAt": {
"$ref": "#/components/schemas/lastArchivedAt"
},
"createdAt": {
"$ref": "#/components/schemas/createdAt"
},
"lastUpdatedAt": {
"$ref": "#/components/schemas/lastUpdatedAt"
},
"links": {
"type": "object",
"additionalProperties": false
}
},
"example": {
"id": "5",
"type": "business-establishment",
"url": "https://example.ilucca.net/lucca-api/business-establishments/5",
"name": "Lucca Marseille",
"remoteId": "00004",
"legalEntity": {
"id": "123",
"type": "legal-entity",
"url": "https://example.ilucca.net/lucca-api/legal-entities/123"
},
"taxIdentificationNumber": {
"format": "franceSIRET",
"value": "0000000000000"
},
"address": {
"addressLines": [
"Lucca",
"10 Place de la Joliette",
"Les Docks Atrium 10.2"
],
"postalCode": "13002",
"locality": "Marseille",
"administrativeArea": "Bouches-du-Rhône",
"countryCode": "FRA"
},
"timezoneId": "Europe/Paris",
"isArchived": false,
"lastArchivedAt": null,
"createdAt": "2024-05-23T13:45:26.0001Z",
"lastUpdatedAt": "2024-05-23T13:45:26.0001Z",
"links": {}
}
},
"business-establishments": {
"title": "business-establishments",
"description": "A collection of [business-establishment](/api-reference/2024-11-01/organization/business-establishment) objects.",
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "business-establishments"
},
"url": {
"type": "string",
"format": "uri"
},
"totalCount": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0,
"description": "Total number of business-establishment resources across all pages that satisfy query parameters."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/business-establishment"
},
"maxItems": 100
}
}
},
{
"$ref": "#/components/schemas/collection.links"
}
]
},
"business-establishment.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "Embeds the representation of resources related to the business-establishment(s).\n\nOnly returned if requested by the API client: `?include=embedded`.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"legal-entity": {
"description": "Legal-entities the business-establishment(s) belong to (cf. `businessEstablishment.legalEntity`).\n\nStructured as a dictionary of [legal-entities](/api-reference/2024-11-01/organization/legal-entity) indexed by ID.",
"type": [
"object",
"null"
],
"additionalProperties": {
"$ref": "#/components/schemas/legal-entity"
}
}
}
}
}
},
"business-establishments.read": {
"allOf": [
{
"$ref": "#/components/schemas/business-establishments"
},
{
"$ref": "#/components/schemas/business-establishment.embedded"
}
]
},
"business-establishment.read": {
"allOf": [
{
"$ref": "#/components/schemas/business-establishment"
},
{
"$ref": "#/components/schemas/business-establishment.embedded"
}
]
},
"department-reference": {
"title": "department-reference",
"description": "Reference to a [department](/api-reference/2024-11-01/organization/department) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "department"
},
"url": {
"type": "string",
"format": "uri"
}
}
},
"employee-reference": {
"title": "employee-reference",
"description": "Reference to an employee resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "employee"
},
"url": {
"type": "string",
"format": "uri"
}
}
},
"department": {
"title": "department",
"description": "A department represents a subdivision of the employee workforce, most often erected around \nthe type of activity they do.\n\nDepartments are a tree-like structure, as any department may be child to another.\n\nNote: contrary to most resources, departments are not attached to business-establishments.\nThis means:\n - business-establishments listed in access rights management do not affect departments.\n - employees may work in different business-establishments (or even legal-entities) and yet\n still belong to the same department.",
"x-tags": [
"organization"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "department"
},
"url": {
"type": "string",
"format": "uri"
},
"remoteId": {
"description": "Identifier of this object in a third-party software.",
"type": [
"null",
"string"
],
"maxLength": 255
},
"isArchived": {
"description": "If this department is archived. Only possible if there are no more employees attached.",
"type": "boolean"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": [
"null",
"string"
]
},
"parent": {
"description": "Reference to the department this department is a child of.",
"oneOf": [
{
"$ref": "#/components/schemas/department-reference"
},
{
"type": "null"
}
]
},
"level": {
"description": "**Read-only.** Depth level of this department in the department tree. At level \"1\", the department has no parent.",
"type": "integer",
"format": "int32",
"minimum": 1
},
"manager": {
"description": "Reference to the employee that acts as the Head of this department.",
"oneOf": [
{
"$ref": "#/components/schemas/employee-reference"
},
{
"type": "null"
}
]
},
"sortOrder": {
"description": "Index (0-based) of the department among its siblings.",
"type": "integer",
"format": "int32",
"minimum": 0
},
"owningApplication": {
"description": "**Can only be set by an authenticated Lucca application.** \nWhen not null, indicates that this department is read-only, given that it is managed by another application (designated by its ID) that is charged with its synchronization.\n**Any write request attempt made from anyone other than the application will be rejected with a 403 Forbidden error.**",
"type": [
"null",
"string"
],
"minLength": 1
},
"links": {
"type": "object",
"additionalProperties": false,
"properties": {
"activeEmployees": {
"$ref": "#/components/schemas/link",
"description": "Link to the paginated list of active employees currently positioned in this department. List may be partial due to insufficient access rights."
}
}
}
},
"example": {
"id": "32",
"type": "department",
"url": "https://example.ilucca.net/lucca-api/departments/32",
"name": "Finances",
"description": null,
"remoteId": "FIN",
"isArchived": false,
"parent": null,
"level": 1,
"manager": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"sortOrder": 2,
"owningApplication": null,
"links": {
"activeEmployees": {
"href": "https://example.ilucca.net/lucca-api/employees?applicableJobPosition.department.id=32"
}
}
}
},
"departments": {
"title": "departments",
"description": "A collection of [department](/api-reference/2024-11-01/organization/department) objects.",
"allOf": [
{
"type": "object",
"required": [
"type",
"url",
"items"
],
"properties": {
"type": {
"type": "string",
"const": "departments"
},
"url": {
"type": "string",
"format": "uri"
},
"totalCount": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0,
"description": "Total number of department resources across all pages that satisfy query parameters."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/department"
},
"maxItems": 100
}
}
},
{
"$ref": "#/components/schemas/collection.links"
}
]
},
"department.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "No embedded resources on a department(s) response. Expect an empty object if embedded are requested.",
"type": [
"object",
"null"
]
}
}
},
"departments.read": {
"allOf": [
{
"$ref": "#/components/schemas/departments"
},
{
"$ref": "#/components/schemas/department.embedded"
}
]
},
"department.update": {
"title": "department",
"description": "A department represents a subdivision of the employee workforce, most often erected around \nthe type of activity they do.\n\nDepartments are a tree-like structure, as any department may be child to another.\n\nNote: contrary to most resources, departments are not attached to business-establishments.\nThis means:\n - business-establishments listed in access rights management do not affect departments.\n - employees may work in different business-establishments (or even legal-entities) and yet\n still belong to the same department.",
"x-tags": [
"organization"
],
"type": "object",
"properties": {
"remoteId": {
"description": "Identifier of this object in a third-party software.",
"type": [
"null",
"string"
],
"maxLength": 255
},
"isArchived": {
"description": "If this department is archived. Only possible if there are no more employees attached.",
"type": "boolean"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": [
"null",
"string"
]
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"title": "department-reference",
"description": "Reference to a [department](/api-reference/2024-11-01/organization/department) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
}
]
},
"manager": {
"oneOf": [
{
"type": "null"
},
{
"title": "employee-reference",
"description": "Reference to an employee resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
}
]
},
"sortOrder": {
"description": "Index (0-based) of the department among its siblings.",
"type": "integer",
"format": "int32",
"minimum": 0
},
"owningApplication": {
"description": "**Can only be set by an authenticated Lucca application.** \nWhen not null, indicates that this department is read-only, given that it is managed by another application (designated by its ID) that is charged with its synchronization.\n**Any write request attempt made from anyone other than the application will be rejected with a 403 Forbidden error.**",
"type": [
"null",
"string"
],
"minLength": 1
}
},
"required": [
"name"
]
},
"department.create": {
"allOf": [
{
"$ref": "#/components/schemas/department.update"
}
]
},
"department.read": {
"allOf": [
{
"$ref": "#/components/schemas/department"
},
{
"$ref": "#/components/schemas/department.embedded"
}
]
},
"profession": {
"title": "profession",
"description": "A profession represent a type of job practiced in the company. Examples may be:\n - Software engineering ;\n - Consulting ;\n - HR operations ;\n - Finances ;\n - Sales ;\n - etc...",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "profession"
},
"url": {
"type": "string",
"format": "uri"
},
"title": {
"description": "**Must be unique**. Leading and trailing spaces are automatically removed.",
"type": "string",
"minLength": 1,
"maxLength": 255
},
"isArchived": {
"description": "Once archived, a profession can no longer be referenced by new job-qualifications.",
"type": "boolean"
},
"t9n": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"$ref": "#/components/schemas/t9n"
}
}
},
"links": {
"type": "object",
"additionalProperties": false
}
},
"example": {
"id": "89",
"type": "profession",
"url": "https://example.ilucca.net/lucca-api/professions/89",
"title": "Developer",
"isArchived": false,
"t9n": {
"title": {
"fr-FR": "Développeur"
}
},
"links": {}
}
},
"professions": {
"title": "professions",
"description": "A collection of profession resources.",
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "professions"
},
"url": {
"type": "string",
"format": "uri"
},
"totalCount": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0,
"description": "Total number of profession resources across all pages that satisfy query parameters."
},
"items": {
"type": "array",
"minItems": 0,
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/profession"
}
}
}
},
{
"$ref": "#/components/schemas/collection.links"
}
]
},
"profession.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "No embedded resources on a profession(s) response. Expect an empty object if embedded are requested.",
"type": [
"object",
"null"
]
}
}
},
"professions.read": {
"allOf": [
{
"$ref": "#/components/schemas/professions"
},
{
"$ref": "#/components/schemas/profession.embedded"
}
]
},
"profession.read": {
"allOf": [
{
"$ref": "#/components/schemas/profession"
},
{
"$ref": "#/components/schemas/profession.embedded"
}
]
},
"business-establishment-reference": {
"title": "business-establishment-reference",
"description": "Reference to a [business-establishment](/api-reference/2024-11-01/organization/business-establishment) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "business-establishment"
},
"url": {
"type": "string",
"format": "uri"
}
}
},
"occupation-category": {
"title": "occupation-category",
"description": "The occupation-category resource represents a categorization of employees belonging to a set of business-establishments.\n\nThese categories can be used as a way of distinguishing employees in reports, or may be used to specify reserved business rules (e.g. in the leaves management system).\n\nIn France, can be used to represent the \"Profession et Catégories Professionnelles\" (P.C.S.).",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "occupation-category"
},
"url": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "**Must be unique**. Invariant name of this occupation-category. Can be translated through `t9n.title.{langTag}`."
},
"businessEstablishments": {
"description": "`null` value **MUST** be interpreted like \"ALL business-establishments, even those that will be created further down the line\".\n\nAs a result, array cannot be empty.",
"type": [
"null",
"array"
],
"minItems": 1,
"items": {
"$ref": "#/components/schemas/business-establishment-reference"
}
},
"t9n": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"$ref": "#/components/schemas/t9n"
}
}
},
"links": {
"type": "object",
"additionalProperties": false
}
},
"example": {
"id": "45",
"type": "occupation-category",
"url": "https://example.ilucca.net/lucca-api/occupation-categories/45",
"title": "Executive",
"businessEstablishments": [
{
"id": "5",
"type": "business-establishment",
"url": "https://example.ilucca.net/lucca-api/business-establishments/5"
}
],
"t9n": {
"title": {
"fr-FR": "Cadre"
}
},
"links": {}
}
},
"occupation-categories": {
"title": "occupation-categories",
"description": "A collection of occupation-category resources.",
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "occupation-categories"
},
"url": {
"type": "string",
"format": "uri"
},
"totalCount": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0,
"description": "Total number of ocupation-category resources across all pages that satisfy query parameters."
},
"items": {
"type": "array",
"minItems": 0,
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/occupation-category"
}
}
}
},
{
"$ref": "#/components/schemas/collection.links"
}
]
},
"occupation-category.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "No embedded resources on a occupation-category(ies) response. Expect an empty object if embedded are requested.",
"type": [
"object",
"null"
]
}
}
},
"occupation-categories.read": {
"allOf": [
{
"$ref": "#/components/schemas/occupation-categories"
},
{
"$ref": "#/components/schemas/occupation-category.embedded"
}
]
},
"occupation-category.read": {
"allOf": [
{
"$ref": "#/components/schemas/occupation-category"
},
{
"$ref": "#/components/schemas/occupation-category.embedded"
}
]
},
"profession-reference": {
"title": "profession-reference",
"description": "Reference to a [profession](/api-reference/2024-11-01/employee-job-qualifications/profession) resource.",
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "profession",
"enum": [
"profession"
],
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
}
},
"examples": [
{
"id": "89",
"type": "profession",
"url": "https://example.ilucca.net/lucca-api/professions/89"
}
]
},
"job-qualification": {
"title": "job-qualification",
"description": "A job-qualification is an object that represents an employee profile regarding their skillset.\n\nIt is composed of both:\n- a [profession](/api-reference/2024-11-01/employee-job-qualifications/profession), which indicates the nature of their job.\n- a rank (number), which indicates either their level of expertise or of responsibilities in the company.",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "job-qualification"
},
"url": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"minLength": 1,
"description": "**Must be unique.** Invariant name of this job-qualification. Can be translated through `t9n.title[{langTag}]`. Leading and trailing spaces are automatically removed."
},
"profession": {
"$ref": "#/components/schemas/profession-reference"
},
"rank": {
"description": "The lower the rank, the \"lower\" in the company's hierarchy (i.e. the CEO is at max rank). Maximum rank can be set trough configuration.",
"type": "integer",
"minimum": 1,
"format": "int32"
},
"t9n": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"$ref": "#/components/schemas/t9n"
}
}
},
"createdAt": {
"$ref": "#/components/schemas/createdAt"
},
"lastUpdatedAt": {
"$ref": "#/components/schemas/lastUpdatedAt"
},
"links": {
"type": "object",
"additionalProperties": false
}
},
"example": {
"id": "982",
"type": "job-qualification",
"url": "https://example.ilucca.net/lucca-api/job-qualifications/982",
"title": "Lead Developer",
"profession": {
"id": "89",
"type": "profession",
"url": "https://example.ilucca.net/lucca-api/professions/89"
},
"rank": 2,
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {}
}
},
"job-qualifications": {
"title": "job-qualifications",
"description": "A collection of [job-qualification](/api-reference/2024-11-01/employee-job-qualifications/job-qualification) objects.",
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "job-qualifications"
},
"url": {
"type": "string",
"format": "uri"
},
"totalCount": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0,
"description": "Total number of job-qualification resources across all pages that satisfy query parameters."
},
"items": {
"type": "array",
"minItems": 0,
"maxItems": 100,
"description": "Paginated list of job-qualification resources.",
"items": {
"$ref": "#/components/schemas/job-qualification"
}
}
}
},
{
"$ref": "#/components/schemas/collection.links"
}
]
},
"job-qualification.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "No embedded resources on a job-qualification(s) response. Expect an empty object if embedded are requested.",
"type": [
"object",
"null"
]
}
}
},
"job-qualifications.read": {
"allOf": [
{
"$ref": "#/components/schemas/job-qualifications"
},
{
"$ref": "#/components/schemas/job-qualification.embedded"
}
]
},
"job-qualification.read": {
"allOf": [
{
"$ref": "#/components/schemas/job-qualification"
},
{
"$ref": "#/components/schemas/job-qualification.embedded"
}
]
},
"employee-status": {
"title": "employee-status",
"description": "**Read-only.** The employee status is calculated from the employee's [employments](/api-reference/2024-11-01/employments/employment).\n- active: employee has an employment as of today.\n- upcoming: employee currently has no employment but will have one in the future.\n- deactivated: employee used to have an employment but no longer does.",
"type": "string",
"enum": [
"active",
"upcoming",
"deactivated"
],
"x-enumDescriptions": {
"active": "Employee has an employment as of today.",
"upcoming": "Employee currently has no employment but will have one in the future.",
"deactivated": "Employee used to have an employment but no longer does."
},
"examples": [
"active"
]
},
"daterange": {
"type": "string",
"description": "[ISO 8601 formatted date-range](/documentation/using-api/filtering#dates-date-times-and-date-time-offsets) string.\nExamples:\n - `2024-01-01--2024-12-31`: from Jan. 1st 2024 until Dec. 31st 2024 (included). \n - `..--2024-12-31`: until Dec. 31st 2024.\n - `2024-01-01--..`: from Jan. 1st 2024.",
"pattern": "^(?:\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])|\\.\\.)--(?:\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])|\\.\\.)$",
"examples": [
"2024-01-01--2024-12-31",
"..--2024-12-31",
"2024-01-01--.."
]
},
"employment-term": {
"title": "employment-term",
"description": "Term of an employment.",
"type": "string",
"enum": [
"permanent",
"fixed"
],
"examples": [
"permanent"
]
},
"datetimeoffsetrange": {
"type": "string",
"description": "[ISO 8601 formatted date-time-offset-range](/documentation/using-api/filtering#dates-date-times-and-date-time-offsets) string.\n**Designed as a right-half-open interval: end is excluded [start, end).**\n\nEach bound must be written as `yyyy-MM-ddTHH:mm:ss`, with optional fractional seconds, followed by an offset (`Z` or `±hh:mm`).\nSeconds are required. A timestamp read from a response payload can be reused as a bound as is,\nwithin [a precision of 100 ns](/documentation/using-api/data-types#fractional-seconds).\n\nExamples:\n - `2026-01-01T00:00:00Z--2027-01-01T00:00:00Z`: from Jan. 1st 2026 until Dec. 31st 2026.\n - `..--2026-06-01T00:00:00Z`: until May 31st 2026 (included).\n - `2026-05-26T00:00:00Z--..`: from May 26th 2026.\n - `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--.."
]
},
"portrait-reference": {
"title": "portrait-reference",
"description": "Reference to a [portrait](/api-reference/2024-11-01/employees/portrait) resource.",
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"readOnly": true,
"properties": {
"id": {
"type": "string",
"minLength": 1,
"readOnly": true
},
"type": {
"type": "string",
"const": "portrait",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
}
}
},
"phone": {
"title": "Phone number",
"description": "Phone number, in international or national format (e.g. \"+33 1 23 45 67 89\" or \"01 23 45 67 89\").",
"type": "string",
"maxLength": 50,
"pattern": "^[\\s0-9+()-]{6,50}$",
"examples": [
"+3356565656",
"01 23 45 67 89"
]
},
"employment-reference": {
"title": "employment-reference",
"description": "Reference to an [employment](/api-reference/2024-11-01/employments/employment) resource.",
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "employment",
"enum": [
"employment"
]
},
"url": {
"type": "string",
"format": "uri"
}
}
},
"job-position-reference": {
"title": "job-position-reference",
"description": "Reference to a [job-position](/api-reference/2024-11-01/employments/job-position) resource.",
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "job-position",
"enum": [
"job-position"
],
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
}
}
},
"file-link": {
"title": "file-link",
"description": "A time-limited download link to a single file.\n\nThe link does not replace your credentials: send the request with the same `Authorization` header you used to read\nthe resource, and, with an OAuth access token, the `files.readonly` or `files.readwrite` scope. The token it carries\nauthorizes your API client to access this one file; another client cannot use it, and without credentials the\nrequest fails with a `401`.\n\n`href` carries both the authorization token and an explicit `disposition`, so following it returns the file content\nwhatever your `Accept` header, with the file name and content type in the `Content-Disposition` and `Content-Type`\nresponse headers.\n\n`null` when you may not download this file.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"href": {
"type": "string",
"format": "uri",
"examples": [
"https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3?token=eyXXXXXXXX&disposition=attachment"
],
"description": "Absolute URL to the file content, carrying the authorization token. Follow it with your own credentials."
},
"expiresAt": {
"type": "string",
"format": "date-time",
"examples": [
"2026-09-12T04:34:12.432Z"
],
"description": "Instant past which `href` stops working. To obtain a fresh link, read the resource again with\n`?include=links`; do not store `href`."
},
"token": {
"type": "string",
"minLength": 1,
"description": "The authorization token carried by `href`, exposed on its own so you can build your own URL to the\n[file](/api-reference/2024-11-01/files/file) endpoint — for instance to request its JSON representation instead of its content."
}
},
"required": [
"href",
"expiresAt",
"token"
]
},
"file-links": {
"title": "file-links",
"description": "Download links to the files referenced by the resource, indexed by file id.\n\nEvery object of type `file` in the resource has an entry here, whatever its depth, and one entry only — even when\nthe same file is referenced several times. On a collection, each item holds the links to its own files.\n\nReturned with the other links of the resource, with `?include=links`.\nRequesting them mints one authorization token per file, so ask for them only when you intend to download.\n\nFollow each `href` with the same credentials you used to read the resource: the token it carries is bound to your\nAPI client and does not authenticate you on its own.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/file-link"
}
},
"employee": {
"title": "employee",
"x-tags": [
"Employees"
],
"description": "The employee represents the public face of an employee in the system. Note that an employee can also represent a trainee, an intern, a contractor, etc...\n\nThe `applicableEmployment` property references the employee's [employment](/api-reference/2024-11-01/employments/employment) that is:\n- currently in effect if the employee is \"active\".\n- will first be in effect if the employee has an employment starting in the future (either the first or a new one).\n- was last in effect if the employee is no longer employed and is not expected to be re-remployed in the future.\n\nThe `applicableJobPosition` property references the employee's [job-position](/api-reference/2024-11-01/employments/job-position) that matches the same logic.",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "employee"
},
"url": {
"type": "string",
"format": "uri"
},
"remoteId": {
"description": "Must be unique.",
"type": [
"null",
"string"
],
"minLength": 1,
"maxLength": 100
},
"portrait": {
"oneOf": [
{
"$ref": "#/components/schemas/portrait-reference"
},
{
"type": "null"
}
],
"description": "Reference to the employee's portrait, which is a file (picture) representing them."
},
"givenName": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"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."
},
"familyName": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Name inherited from the person's family. In the U.S.A., the last name of a person. In French: \"nom (de famille)\". Leading and trailing spaces are automatically removed."
},
"employeeNumber": {
"type": [
"null",
"string"
],
"minLength": 1,
"maxLength": 50
},
"status": {
"$ref": "#/components/schemas/employee-status"
},
"email": {
"description": "Professional email of this employee. \"<\" and \">\" characters are forbidden. Some domains are blacklisted and may thus result in 400 errors.",
"type": [
"null",
"string"
],
"format": "idn-email",
"minLength": 3,
"maxLength": 255
},
"birthDay": {
"description": "Year-less date of birth.\n\n**Read-only**, as it is infered from the employee-personal-record `birthDate`.\nTake note that `month` starts at \"1\" and not zero, i.e. \"1\" is for January, \"2\" for February, etc...",
"type": [
"null",
"object"
],
"properties": {
"day": {
"description": "Starts at \"1\". Maximum depends on the month.",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 31
},
"month": {
"description": "Starts at \"1\" and goes up to \"12\" (included).",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 12
}
},
"additionalProperties": false,
"required": [
"day",
"month"
]
},
"phoneNumber": {
"oneOf": [
{
"$ref": "#/components/schemas/phone"
},
{
"type": "null"
}
],
"description": "Professional mobile phone number of this employee."
},
"applicableEmployment": {
"description": "**Read-only.** Reference to the applicable [employment](/api-reference/2024-11-01/employments/employment) of this employee.\nIf the employee status is \"deactivated\", then references their last employment.\nIf the employee status is \"upcoming\", then references their closest next employment.",
"$ref": "#/components/schemas/employment-reference"
},
"applicableJobPosition": {
"description": "**Read-only.** Reference to the active [job-position](/api-reference/2024-11-01/employments/job-position) of this employee.\nMatches the same logic as the \"applicableEmployment\".",
"$ref": "#/components/schemas/job-position-reference"
},
"createdAt": {
"$ref": "#/components/schemas/createdAt"
},
"lastUpdatedAt": {
"$ref": "#/components/schemas/lastUpdatedAt"
},
"links": {
"type": "object",
"additionalProperties": false,
"properties": {
"employments": {
"$ref": "#/components/schemas/link"
},
"jobPositions": {
"$ref": "#/components/schemas/link"
},
"personalRecord": {
"$ref": "#/components/schemas/link"
},
"portrait": {
"$ref": "#/components/schemas/link",
"deprecated": true,
"description": "Link to the JSON representation of the `portrait` file, carrying its token. Use `links.files[\"{id}\"]`\ninstead, where `{id}` is the `portrait` id, which downloads the file content and tells when its token expires."
},
"files": {
"$ref": "#/components/schemas/file-links"
}
}
}
},
"example": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416",
"remoteId": "00002345",
"portrait": {
"id": "2face165-5345-4cf3-ab05-5421a6b19df2",
"type": "portrait",
"url": "https://example.ilucca.net/lucca-api/portraits/2face165-5345-4cf3-ab05-5421a6b19df2"
},
"givenName": "Edward",
"familyName": "Atkinson",
"employeeNumber": "E000124",
"status": "active",
"email": "eatkinson@acme.corp",
"birthDay": {
"day": 22,
"month": 12
},
"phoneNumber": "+33145784512",
"applicableEmployment": {
"id": "154",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/154"
},
"applicableJobPosition": {
"id": "74",
"type": "job-position",
"url": "https://example.ilucca.net/lucca-api/job-positions/74"
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"portrait": {
"href": "https://example.ilucca.net/lucca-api/files/2face165-5345-4cf3-ab05-5421a6b19df2?token=eyXXXXXXXX"
},
"employments": {
"href": "https://example.ilucca.net/lucca-api/employments?employee.id=416"
},
"jobPositions": {
"href": "https://example.ilucca.net/lucca-api/job-positions?employment.employee.id=416"
},
"personalRecord": {
"href": "https://example.ilucca.net/lucca-api/employee-personal-records?employee.id=416"
},
"files": {
"2face165-5345-4cf3-ab05-5421a6b19df2": {
"href": "https://example.ilucca.net/lucca-api/files/2face165-5345-4cf3-ab05-5421a6b19df2?token=eyXXXXXXXX&disposition=attachment",
"expiresAt": "2026-10-21T15:01:38.7634288Z",
"token": "eyXXXXXXXX"
}
}
}
}
},
"employees": {
"title": "employees",
"description": "A collection of [employee](/api-reference/2024-11-01/employees/employee) objects.",
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "employees"
},
"url": {
"type": "string",
"format": "uri"
},
"totalCount": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0,
"description": "Total number of employee resources across all pages that satisfy query parameters."
},
"items": {
"type": "array",
"minItems": 0,
"maxItems": 1000,
"description": "Paginated list of employee resources.",
"items": {
"$ref": "#/components/schemas/employee"
}
}
}
},
{
"$ref": "#/components/schemas/collection.links"
}
]
},
"file-reference": {
"title": "file-reference",
"description": "Reference to a [file](/api-reference/2024-11-01/files/file) resource.",
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "file",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "Does not give access to the file on its own: downloading a file requires a token. Read the\nresource that references the file with `?include=links` and follow\n`links.files[\"{id}\"].href`. Read more in [Get Started With Files](/api-reference/latest/files/get-started)."
}
}
},
"employment-template-reference": {
"title": "employment-template-reference",
"description": "Reference to an [employment-template](/api-reference/2024-11-01/employments/employment-template) resource.",
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "employment-template",
"enum": [
"employment-template"
],
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
}
}
},
"employment": {
"title": "employment",
"description": "The employment resource represents a relationship between an [employee](/api-reference/2024-11-01/employees/employee) and a [legal-entity](/api-reference/2024-11-01/organization/legal-entity) over a continuous period. It may actually represent a work contract, an internship agreement, a contractor's contract, etc...\n\nThe actual job of the employee is defined through the [job-position](/api-reference/2024-11-01/employments/job-position) resource, which references an employment. Over the course of his/her employment, the employee may occupy several job-positions.",
"x-tags": [
"employees"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "employment"
},
"url": {
"type": "string",
"format": "uri"
},
"remoteId": {
"type": [
"null",
"string"
],
"minLength": 1,
"maxLength": 200,
"description": "Resource identifier in a third-party system."
},
"employee": {
"$ref": "#/components/schemas/employee-reference"
},
"legalEntity": {
"$ref": "#/components/schemas/legal-entity-reference",
"description": "**Read-only**. Reference to a legal-entity. Inferred from the business-establishment of its first job-position."
},
"status": {
"$ref": "#/components/schemas/employee-status"
},
"start": {
"type": "object",
"required": [
"date"
],
"additionalProperties": false,
"properties": {
"date": {
"description": "Date of the first day (included) of this employment.",
"type": "string",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$",
"format": "date"
}
}
},
"end": {
"type": [
"null",
"object"
],
"additionalProperties": false,
"required": [
"date"
],
"properties": {
"date": {
"description": "Date of the last day (included) of this employment. After this date, this employment is considered terminated.\n\nLeave `null` for permanent employments (as long as the employee is kept), and set the date of the last day in case of a fixed-term employment.\n\nEndsOn date must be greater or equal than StartsOn date.",
"type": "string",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$",
"format": "date"
}
}
},
"document": {
"oneOf": [
{
"$ref": "#/components/schemas/file-reference"
},
{
"type": "null"
}
]
},
"template": {
"$ref": "#/components/schemas/employment-template-reference"
},
"createdAt": {
"$ref": "#/components/schemas/createdAt"
},
"lastUpdatedAt": {
"$ref": "#/components/schemas/lastUpdatedAt"
},
"links": {
"type": "object",
"additionalProperties": false,
"properties": {
"document": {
"$ref": "#/components/schemas/link",
"deprecated": true,
"description": "Link to the JSON representation of the `document` file, carrying its token. Use `links.files[\"{id}\"]`\ninstead, which downloads the file content and tells when its token expires."
},
"jobPositions": {
"$ref": "#/components/schemas/link",
"description": "Link to the related [job-positions](/api-reference/2024-11-01/employments/job-position) for this employment."
},
"probationaryPeriods": {
"$ref": "#/components/schemas/link",
"description": "Link to the related probationary-periods for this employment."
},
"files": {
"$ref": "#/components/schemas/file-links"
}
}
}
},
"example": {
"id": "4561",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/4561",
"remoteId": "EMPLOYMENT#4512-ac",
"employee": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"legalEntity": {
"id": "123",
"type": "legal-entity",
"url": "https://example.ilucca.net/lucca-api/legal-entities/123"
},
"status": "active",
"start": {
"date": "2024-01-01"
},
"end": null,
"document": {
"id": "9154c6a2-6105-4d5d-bfb6-5fd2d54037b3",
"type": "file",
"url": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3"
},
"template": {
"id": "4",
"type": "employment-template",
"url": "https://example.ilucca.net/lucca-api/employment-templates/4"
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"document": {
"href": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3?token=eyXXXXXXXX&disposition=json"
},
"jobPositions": {
"href": "https://example.ilucca.net/lucca-api/job-positions?employment.id=4561"
},
"probationaryPeriods": {
"href": "https://example.ilucca.net/lucca-api/probationary-periods?employment.id=4561"
},
"files": {
"9154c6a2-6105-4d5d-bfb6-5fd2d54037b3": {
"href": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3?token=eyXXXXXXXX&disposition=attachment",
"expiresAt": "2026-10-21T15:01:38.7634288Z",
"token": "eyXXXXXXXX"
}
}
}
}
},
"job-qualification-reference": {
"title": "job-qualification-reference",
"description": "Reference to a [job-qualification](/api-reference/2024-11-01/employee-job-qualifications/job-qualification) resource.",
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "job-qualification",
"enum": [
"job-qualification"
],
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
}
}
},
"occupation-category-reference": {
"title": "occupation-category-reference",
"description": "Reference to an [occupation-category](/api-reference/2024-11-01/employee-occupation-categories/occupation-category) resource.",
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "occupation-category",
"enum": [
"occupation-category"
],
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
}
}
},
"working-time-arrangement-reference": {
"title": "working-time-arrangement-reference",
"description": "Reference to a working-time-arrangement resource.",
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "working-time-arrangement",
"enum": [
"working-time-arrangement"
],
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
}
}
},
"job-position-changed-attributes": {
"title": "job-position-changed-attributes",
"description": "List of attributes that can change for a job-position.",
"type": "string",
"enum": [
"remoteId",
"businessEstablishment",
"jobTitle",
"jobQualification",
"manager",
"occupationCategory",
"workingTimeArrangement",
"department",
"document",
"notes"
]
},
"job-position": {
"title": "job-position",
"x-tags": [
"Employees"
],
"description": "The job position represents a stage in an [employee](/api-reference/2024-11-01/employees/employee)'s career during one of their [employment](/api-reference/2024-11-01/employments/employment) in a given [business-establishment](/api-reference/2024-11-01/organization/business-establishment).\n\nIt therefore outlines the attributes of the person as a professional (qualifications) and their role in the company as well as who's their manager.",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "job-position"
},
"url": {
"type": "string",
"format": "uri"
},
"remoteId": {
"minLength": 1,
"maxLength": 1024,
"description": "Resource identifier in a third-party system. No unicity constraint: two job-positions may have the same value.",
"type": [
"null",
"string"
]
},
"employment": {
"$ref": "#/components/schemas/employment-reference"
},
"employee": {
"description": "**Read-only.** Reference to the employment's employee.",
"$ref": "#/components/schemas/employee-reference"
},
"status": {
"$ref": "#/components/schemas/employee-status"
},
"startsOn": {
"description": "Effective date of this job-position for this employee.\n\nCannot be outside the range of the employment.\n\nThe `startsOn` of the first job-position of an employment follows the employment `start.date`: change the employment start instead, as updating it directly returns a `400`.\n\nThis should be considered \"applicable\" based on the related [employment](/api-reference/2024-11-01/employments/employment) business-establishment timezone.",
"type": "string",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$",
"format": "date"
},
"endsOn": {
"description": "**Read-only.** End date (included) of this job-position effectiveness.\n\nIs calculated from the `startsOn` property of the closest next job-position, or the `endsOn` date of the parent employment.\n\nThis should be considered \"applicable\" based on the related [employment](/api-reference/2024-11-01/employments/employment) business-establishment timezone.\n\nMust be greater or equal than StartsOn date.",
"type": [
"null",
"string"
],
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$",
"format": "date"
},
"businessEstablishment": {
"$ref": "#/components/schemas/business-establishment-reference"
},
"jobTitle": {
"description": "Short description of the job occupied by this employee.",
"type": [
"null",
"string"
],
"maxLength": 1024,
"minLength": 1
},
"jobQualification": {
"oneOf": [
{
"$ref": "#/components/schemas/job-qualification-reference"
},
{
"type": "null"
}
]
},
"manager": {
"oneOf": [
{
"$ref": "#/components/schemas/employee-reference"
},
{
"type": "null"
}
],
"description": "Reference to another employee, who is considered to be this employee's manager."
},
"occupationCategory": {
"oneOf": [
{
"$ref": "#/components/schemas/occupation-category-reference"
},
{
"type": "null"
}
]
},
"workingTimeArrangement": {
"oneOf": [
{
"$ref": "#/components/schemas/working-time-arrangement-reference"
},
{
"type": "null"
}
]
},
"department": {
"$ref": "#/components/schemas/department-reference"
},
"document": {
"oneOf": [
{
"$ref": "#/components/schemas/file-reference"
},
{
"type": "null"
}
]
},
"notes": {
"type": [
"null",
"string"
],
"maxLength": 500,
"description": "Optional notes about this job-position change."
},
"t9n": {
"type": "object",
"additionalProperties": false,
"properties": {
"jobTitle": {
"$ref": "#/components/schemas/t9n"
}
}
},
"updatedAttributes": {
"description": "List of attributes that changed compared with this employee previous job-position, even if said job-position was on another employment and/or not immediately sequential.",
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/job-position-changed-attributes"
}
},
"createdAt": {
"$ref": "#/components/schemas/createdAt"
},
"lastUpdatedAt": {
"$ref": "#/components/schemas/lastUpdatedAt"
},
"links": {
"type": "object",
"properties": {
"document": {
"$ref": "#/components/schemas/link",
"deprecated": true,
"description": "Link to the JSON representation of the `document` file, carrying its token. Use `links.files[\"{id}\"]`\ninstead, which downloads the file content and tells when its token expires."
},
"files": {
"$ref": "#/components/schemas/file-links"
}
},
"additionalProperties": false
}
},
"example": {
"id": "74",
"type": "job-position",
"url": "https://example.ilucca.net/lucca-api/job-positions/74",
"remoteId": null,
"employment": {
"id": "28",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/28"
},
"employee": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"status": "active",
"startsOn": "2024-01-01",
"endsOn": null,
"businessEstablishment": {
"id": "5",
"type": "business-establishment",
"url": "https://example.ilucca.net/lucca-api/business-establishments/5"
},
"jobTitle": "Developer",
"jobQualification": {
"id": "982",
"type": "job-qualification",
"url": "https://example.ilucca.net/lucca-api/job-qualifications/982"
},
"manager": {
"id": "541",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/541"
},
"occupationCategory": {
"id": "12",
"type": "occupation-category",
"url": "https://example.ilucca.net/lucca-api/occupation-categories/12"
},
"workingTimeArrangement": {
"id": "23",
"type": "working-time-arrangement",
"url": "https://example.ilucca.net/lucca-api/working-time-arrangements/23"
},
"department": {
"id": "32",
"type": "department",
"url": "https://example.ilucca.net/lucca-api/departments/32"
},
"document": {
"id": "c3b1f0de-7a42-4f8e-9d61-2b5e8a0f4c17",
"type": "file",
"url": "https://example.ilucca.net/lucca-api/files/c3b1f0de-7a42-4f8e-9d61-2b5e8a0f4c17"
},
"notes": null,
"t9n": {
"jobTitle": {
"fr-FR": "Développeur"
}
},
"updatedAttributes": [
"jobTitle",
"jobQualification"
],
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"document": {
"href": "https://example.ilucca.net/lucca-api/files/c3b1f0de-7a42-4f8e-9d61-2b5e8a0f4c17?token=eyXXXXXXXX&disposition=json"
},
"files": {
"c3b1f0de-7a42-4f8e-9d61-2b5e8a0f4c17": {
"href": "https://example.ilucca.net/lucca-api/files/c3b1f0de-7a42-4f8e-9d61-2b5e8a0f4c17?token=eyXXXXXXXX&disposition=attachment",
"expiresAt": "2026-10-21T15:01:38.7634288Z",
"token": "eyXXXXXXXX"
}
}
}
}
},
"employee.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "Embeds the representation of resources related to the employee(s).\n\nOnly returned if requested by the API client: `?include=embedded`.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"employment": {
"type": [
"object",
"null"
],
"description": "Applicable employments of employee(s) (cf. `employee.applicableEmployment`).\n\nStructured as a dictionary of [employments](/api-reference/2024-11-01/employments/employment) indexed by their ID.",
"additionalProperties": {
"$ref": "#/components/schemas/employment"
}
},
"job-position": {
"type": [
"object",
"null"
],
"description": "Applicable job-positions of employee(s) (cf. `employee.applicableJobPosition`).\n\nStructured as a dictionary of [job-positions](/api-reference/2024-11-01/employments/job-position) indexed by ID.",
"additionalProperties": {
"$ref": "#/components/schemas/job-position"
}
},
"department": {
"type": [
"object",
"null"
],
"description": "Departments of the applicable job-positions of employee(s) (cf. `jobPosition.department`).\n\nStructured as a dictionary of [departments](/api-reference/2024-11-01/organization/department) indexed by their ID.",
"additionalProperties": {
"$ref": "#/components/schemas/department"
}
}
}
}
}
},
"employees.read": {
"allOf": [
{
"$ref": "#/components/schemas/employees"
},
{
"$ref": "#/components/schemas/employee.embedded"
}
]
},
"employee.update": {
"title": "employee",
"x-tags": [
"Employees"
],
"description": "The employee represents the public face of an employee in the system. Note that an employee can also represent a trainee, an intern, a contractor, etc...\n\nThe `applicableEmployment` property references the employee's [employment](/api-reference/2024-11-01/employments/employment) that is:\n- currently in effect if the employee is \"active\".\n- will first be in effect if the employee has an employment starting in the future (either the first or a new one).\n- was last in effect if the employee is no longer employed and is not expected to be re-remployed in the future.\n\nThe `applicableJobPosition` property references the employee's [job-position](/api-reference/2024-11-01/employments/job-position) that matches the same logic.",
"type": "object",
"properties": {
"remoteId": {
"description": "Must be unique.",
"type": [
"null",
"string"
],
"minLength": 1,
"maxLength": 100
},
"portrait": {
"oneOf": [
{
"$ref": "#/components/schemas/portrait-reference"
},
{
"type": "null"
}
],
"description": "Reference to the employee's portrait, which is a file (picture) representing them."
},
"givenName": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"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."
},
"familyName": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Name inherited from the person's family. In the U.S.A., the last name of a person. In French: \"nom (de famille)\". Leading and trailing spaces are automatically removed."
},
"employeeNumber": {
"type": [
"null",
"string"
],
"minLength": 1,
"maxLength": 50
},
"email": {
"description": "Professional email of this employee. \"<\" and \">\" characters are forbidden. Some domains are blacklisted and may thus result in 400 errors.",
"type": [
"null",
"string"
],
"format": "idn-email",
"minLength": 3,
"maxLength": 255
},
"phoneNumber": {
"oneOf": [
{
"$ref": "#/components/schemas/phone"
},
{
"type": "null"
}
],
"description": "Professional mobile phone number of this employee."
}
}
},
"job-position.create": {
"title": "job-position",
"x-tags": [
"Employees"
],
"description": "The job position represents a stage in an [employee](/api-reference/2024-11-01/employees/employee)'s career during one of their [employment](/api-reference/2024-11-01/employments/employment) in a given [business-establishment](/api-reference/2024-11-01/organization/business-establishment).\n\nIt therefore outlines the attributes of the person as a professional (qualifications) and their role in the company as well as who's their manager.",
"type": "object",
"properties": {
"remoteId": {
"minLength": 1,
"maxLength": 1024,
"description": "Resource identifier in a third-party system. No unicity constraint: two job-positions may have the same value.",
"type": [
"null",
"string"
]
},
"employment": {
"title": "employment-reference",
"description": "Reference to an [employment](/api-reference/2024-11-01/employments/employment) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
"startsOn": {
"description": "Effective date of this job-position for this employee.\n\nCannot be outside the range of the employment.\n\nThe `startsOn` of the first job-position of an employment follows the employment `start.date`: change the employment start instead, as updating it directly returns a `400`.\n\nThis should be considered \"applicable\" based on the related [employment](/api-reference/2024-11-01/employments/employment) business-establishment timezone.",
"type": "string",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$",
"format": "date"
},
"businessEstablishment": {
"title": "business-establishment-reference",
"description": "Reference to a [business-establishment](/api-reference/2024-11-01/organization/business-establishment) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
}
},
"jobTitle": {
"description": "Short description of the job occupied by this employee.",
"type": [
"null",
"string"
],
"maxLength": 1024,
"minLength": 1
},
"jobQualification": {
"oneOf": [
{
"title": "job-qualification-reference",
"description": "Reference to a [job-qualification](/api-reference/2024-11-01/employee-job-qualifications/job-qualification) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
{
"type": "null"
}
]
},
"manager": {
"oneOf": [
{
"title": "employee-reference",
"description": "Reference to an employee resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
}
},
{
"type": "null"
}
]
},
"occupationCategory": {
"oneOf": [
{
"title": "occupation-category-reference",
"description": "Reference to an [occupation-category](/api-reference/2024-11-01/employee-occupation-categories/occupation-category) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
{
"type": "null"
}
]
},
"workingTimeArrangement": {
"oneOf": [
{
"title": "working-time-arrangement-reference",
"description": "Reference to a working-time-arrangement resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
{
"type": "null"
}
]
},
"department": {
"title": "department-reference",
"description": "Reference to a [department](/api-reference/2024-11-01/organization/department) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
}
},
"document": {
"oneOf": [
{
"title": "file-reference",
"description": "Reference to a [file](/api-reference/2024-11-01/files/file) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
{
"type": "null"
}
]
},
"notes": {
"type": [
"null",
"string"
],
"maxLength": 500,
"description": "Optional notes about this job-position change."
},
"t9n": {
"type": "object",
"additionalProperties": false,
"properties": {
"jobTitle": {
"$ref": "#/components/schemas/t9n"
}
}
}
},
"required": [
"employment",
"startsOn",
"businessEstablishment",
"department"
]
},
"employment.create": {
"title": "employment",
"description": "The employment resource represents a relationship between an [employee](/api-reference/2024-11-01/employees/employee) and a [legal-entity](/api-reference/2024-11-01/organization/legal-entity) over a continuous period. It may actually represent a work contract, an internship agreement, a contractor's contract, etc...\n\nThe actual job of the employee is defined through the [job-position](/api-reference/2024-11-01/employments/job-position) resource, which references an employment. Over the course of his/her employment, the employee may occupy several job-positions.",
"x-tags": [
"employees"
],
"type": "object",
"properties": {
"remoteId": {
"type": [
"null",
"string"
],
"minLength": 1,
"maxLength": 200,
"description": "Resource identifier in a third-party system."
},
"employee": {
"title": "employee-reference",
"description": "Reference to an employee resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
}
},
"legalEntity": {
"description": "Reference to a legal-entity. It must be the legal-entity of the business-establishment of the first job-position, otherwise the API returns a `400`.",
"allOf": [
{
"title": "Reference to a legal-entity",
"description": "Reference to a [legal-entity](/api-reference/2024-11-01/organization/legal-entity) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
}
]
},
"start": {
"type": "object",
"required": [
"date"
],
"additionalProperties": false,
"properties": {
"date": {
"description": "Date of the first day (included) of this employment.",
"type": "string",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$",
"format": "date"
}
}
},
"end": {
"type": [
"null",
"object"
],
"additionalProperties": false,
"required": [
"date"
],
"properties": {
"date": {
"description": "Date of the last day (included) of this employment. After this date, this employment is considered terminated.\n\nLeave `null` for permanent employments (as long as the employee is kept), and set the date of the last day in case of a fixed-term employment.\n\nEndsOn date must be greater or equal than StartsOn date.",
"type": "string",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$",
"format": "date"
}
}
},
"document": {
"oneOf": [
{
"title": "file-reference",
"description": "Reference to a [file](/api-reference/2024-11-01/files/file) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
{
"type": "null"
}
]
},
"template": {
"title": "employment-template-reference",
"description": "Reference to an [employment-template](/api-reference/2024-11-01/employments/employment-template) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
"firstJobPosition": {
"title": "job-position",
"x-tags": [
"Employees"
],
"description": "The job position represents a stage in an [employee](/api-reference/2024-11-01/employees/employee)'s career during one of their [employment](/api-reference/2024-11-01/employments/employment) in a given [business-establishment](/api-reference/2024-11-01/organization/business-establishment).\n\nIt therefore outlines the attributes of the person as a professional (qualifications) and their role in the company as well as who's their manager.",
"type": "object",
"properties": {
"remoteId": {
"minLength": 1,
"maxLength": 1024,
"description": "Resource identifier in a third-party system. No unicity constraint: two job-positions may have the same value.",
"type": [
"null",
"string"
]
},
"businessEstablishment": {
"title": "business-establishment-reference",
"description": "Reference to a [business-establishment](/api-reference/2024-11-01/organization/business-establishment) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
}
},
"jobTitle": {
"description": "Short description of the job occupied by this employee.",
"type": [
"null",
"string"
],
"maxLength": 1024,
"minLength": 1
},
"jobQualification": {
"oneOf": [
{
"title": "job-qualification-reference",
"description": "Reference to a [job-qualification](/api-reference/2024-11-01/employee-job-qualifications/job-qualification) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
{
"type": "null"
}
]
},
"manager": {
"oneOf": [
{
"title": "employee-reference",
"description": "Reference to an employee resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
}
},
{
"type": "null"
}
]
},
"occupationCategory": {
"oneOf": [
{
"title": "occupation-category-reference",
"description": "Reference to an [occupation-category](/api-reference/2024-11-01/employee-occupation-categories/occupation-category) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
{
"type": "null"
}
]
},
"workingTimeArrangement": {
"oneOf": [
{
"title": "working-time-arrangement-reference",
"description": "Reference to a working-time-arrangement resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
{
"type": "null"
}
]
},
"department": {
"title": "department-reference",
"description": "Reference to a [department](/api-reference/2024-11-01/organization/department) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
}
},
"document": {
"oneOf": [
{
"title": "file-reference",
"description": "Reference to a [file](/api-reference/2024-11-01/files/file) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
{
"type": "null"
}
]
},
"t9n": {
"type": "object",
"additionalProperties": false,
"properties": {
"jobTitle": {
"$ref": "#/components/schemas/t9n"
}
}
}
},
"required": [
"businessEstablishment",
"department"
]
}
},
"required": [
"employee",
"start",
"legalEntity",
"template",
"firstJobPosition"
]
},
"employee.create": {
"type": "object",
"required": [
"givenName",
"familyName",
"remoteId",
"firstEmployment"
],
"allOf": [
{
"$ref": "#/components/schemas/employee.update"
},
{
"type": "object",
"properties": {
"remoteId": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Login of the employee. Must be unique."
},
"firstEmployment": {
"title": "employment",
"description": "The employment resource represents a relationship between an [employee](/api-reference/2024-11-01/employees/employee) and a [legal-entity](/api-reference/2024-11-01/organization/legal-entity) over a continuous period. It may actually represent a work contract, an internship agreement, a contractor's contract, etc...\n\nThe actual job of the employee is defined through the [job-position](/api-reference/2024-11-01/employments/job-position) resource, which references an employment. Over the course of his/her employment, the employee may occupy several job-positions.",
"x-tags": [
"employees"
],
"type": "object",
"properties": {
"remoteId": {
"type": [
"null",
"string"
],
"minLength": 1,
"maxLength": 200,
"description": "Resource identifier in a third-party system."
},
"legalEntity": {
"description": "Reference to a legal-entity. It must be the legal-entity of the business-establishment of the first job-position, otherwise the API returns a `400`.",
"allOf": [
{
"title": "Reference to a legal-entity",
"description": "Reference to a [legal-entity](/api-reference/2024-11-01/organization/legal-entity) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
}
]
},
"start": {
"type": "object",
"required": [
"date"
],
"additionalProperties": false,
"properties": {
"date": {
"description": "Date of the first day (included) of this employment.",
"type": "string",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$",
"format": "date"
}
}
},
"end": {
"type": [
"null",
"object"
],
"additionalProperties": false,
"required": [
"date"
],
"properties": {
"date": {
"description": "Date of the last day (included) of this employment. After this date, this employment is considered terminated.\n\nLeave `null` for permanent employments (as long as the employee is kept), and set the date of the last day in case of a fixed-term employment.\n\nEndsOn date must be greater or equal than StartsOn date.",
"type": "string",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$",
"format": "date"
}
}
},
"document": {
"oneOf": [
{
"title": "file-reference",
"description": "Reference to a [file](/api-reference/2024-11-01/files/file) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
{
"type": "null"
}
]
},
"template": {
"title": "employment-template-reference",
"description": "Reference to an [employment-template](/api-reference/2024-11-01/employments/employment-template) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
"firstJobPosition": {
"title": "job-position",
"x-tags": [
"Employees"
],
"description": "The job position represents a stage in an [employee](/api-reference/2024-11-01/employees/employee)'s career during one of their [employment](/api-reference/2024-11-01/employments/employment) in a given [business-establishment](/api-reference/2024-11-01/organization/business-establishment).\n\nIt therefore outlines the attributes of the person as a professional (qualifications) and their role in the company as well as who's their manager.",
"type": "object",
"properties": {
"remoteId": {
"minLength": 1,
"maxLength": 1024,
"description": "Resource identifier in a third-party system. No unicity constraint: two job-positions may have the same value.",
"type": [
"null",
"string"
]
},
"businessEstablishment": {
"title": "business-establishment-reference",
"description": "Reference to a [business-establishment](/api-reference/2024-11-01/organization/business-establishment) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
}
},
"jobTitle": {
"description": "Short description of the job occupied by this employee.",
"type": [
"null",
"string"
],
"maxLength": 1024,
"minLength": 1
},
"jobQualification": {
"oneOf": [
{
"title": "job-qualification-reference",
"description": "Reference to a [job-qualification](/api-reference/2024-11-01/employee-job-qualifications/job-qualification) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
{
"type": "null"
}
]
},
"manager": {
"oneOf": [
{
"title": "employee-reference",
"description": "Reference to an employee resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
}
},
{
"type": "null"
}
]
},
"occupationCategory": {
"oneOf": [
{
"title": "occupation-category-reference",
"description": "Reference to an [occupation-category](/api-reference/2024-11-01/employee-occupation-categories/occupation-category) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
{
"type": "null"
}
]
},
"workingTimeArrangement": {
"oneOf": [
{
"title": "working-time-arrangement-reference",
"description": "Reference to a working-time-arrangement resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
{
"type": "null"
}
]
},
"department": {
"title": "department-reference",
"description": "Reference to a [department](/api-reference/2024-11-01/organization/department) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
}
},
"document": {
"oneOf": [
{
"title": "file-reference",
"description": "Reference to a [file](/api-reference/2024-11-01/files/file) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
{
"type": "null"
}
]
},
"t9n": {
"type": "object",
"additionalProperties": false,
"properties": {
"jobTitle": {
"$ref": "#/components/schemas/t9n"
}
}
}
},
"required": [
"businessEstablishment",
"department"
]
}
},
"required": [
"start",
"legalEntity",
"template",
"firstJobPosition"
]
}
}
}
]
},
"employee.read": {
"allOf": [
{
"$ref": "#/components/schemas/employee"
},
{
"$ref": "#/components/schemas/employee.embedded"
}
]
},
"taxonomy-reference": {
"title": "taxonomy-reference",
"description": "Reference to a taxonomy.",
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "taxonomy",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
}
}
},
"isArchived": {
"type": "boolean",
"description": "When false, resource is not archived.\nWhen true, resource is archived.\n\nYou can update this property in order to set the\narchival status of the resource."
},
"extension-definition": {
"title": "extension-definition",
"description": "extension-definition",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^\\w{1,255}",
"description": "Client-generated identifier."
},
"type": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string",
"minLength": 1
},
"schema": {
"description": "JSON schema of the attribute value. [Read more about employee attribute definition schemas](/api-reference/2024-11-01/employee-attributes/attribute-definition-schemas).\n\nThe schema embeds the base schema it is built on, identified by its `$id`, e.g.:\n```json\n{\n \"schema\": {\n \"$id\": \"/lucca-api/schemas/taxonomy-label-reference\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"title\": \"taxonomy-label-reference\",\n \"type\": [\"object\", \"null\"],\n \"additionalProperties\": false,\n \"required\": [\"id\"],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"type\": {\n \"type\": \"string\",\n \"const\": \"taxonomy-label\",\n \"readOnly\": true\n },\n \"url\": {\n \"type\": \"string\",\n \"format\": \"uri\",\n \"readOnly\": true\n }\n }\n }\n}\n```\n\nDefinitions based on the same base schema all embed it with the same `$id`, and identical `$id`s always denote identical schemas. If you register these schemas in a JSON Schema validator (e.g. to validate values before writing them), register each `$id` once: registering it again makes validators such as Ajv fail with a \"schema already exists\" error.",
"type": "object"
},
"propertyDescriptions": {
"type": [
"object",
"null"
],
"description": "Required whenever this definition schema is of type \"object\". \nThis property is a dictionary whose keys are the name of the schema object properties.",
"additionalProperties": {
"type": "object",
"required": [
"name",
"sortOrder"
],
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"taxonomy": {
"anyOf": [
{
"$ref": "#/components/schemas/taxonomy-reference"
},
{
"type": "null"
}
]
},
"sortOrder": {
"type": "integer",
"minimum": 0
},
"t9n": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/components/schemas/t9n"
}
}
}
}
}
},
"taxonomy": {
"description": "Whenever the expected schema is a taxonomy-label reference, then the taxonomy these labels must belong to must be indicated.",
"anyOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/taxonomy-reference"
}
]
},
"isArchived": {
"$ref": "#/components/schemas/isArchived"
},
"lastArchivedAt": {
"$ref": "#/components/schemas/lastArchivedAt"
},
"t9n": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/components/schemas/t9n"
}
}
},
"links": {
"type": [
"object",
"null"
]
}
}
},
"extension-definition-multiple-value-handling": {
"type": "object",
"properties": {
"multipleValueHandling": {
"description": "Behavior regarding multiple extension values per single extended resource. When `null`, then only a single extension can exist for any extended resource. Multiple extensions may be accepted otherwise.\n\nExample: \"employee's children\" would accept multiple value, when \"employee's blood type\" would not.",
"type": [
"object",
"null"
],
"required": [
"sorting"
],
"properties": {
"sorting": {
"description": "In case of multiple extensions per resource, how should the client sort them (direction)?",
"type": "string",
"enum": [
"ascending",
"descending"
]
},
"sortingProperty": {
"description": "Not null for \"object\" schemas, in which case it points to the object property clients should sort extensions on: `extension.value[{sortingProperty}]`.\nNull otherwise, in which case clients are expected to sort on the actual `extension.value`.",
"type": [
"string",
"null"
]
}
}
}
}
},
"employee-attribute-definition": {
"title": "employee-attribute-definition",
"description": "employee-attribute-definition",
"allOf": [
{
"$ref": "#/components/schemas/extension-definition"
},
{
"$ref": "#/components/schemas/extension-definition-multiple-value-handling"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "employee-attribute-definition"
},
"targetType": {
"type": "string",
"enum": [
"employee",
"employment",
"job-position"
]
},
"category": {
"type": "string",
"enum": [
"system",
"extension"
],
"readOnly": true,
"description": "**Read-only.** Which API surface exposes the values of this definition, regardless of who provides them.\n\n- `system`: the value is a property of the primary resource named by `targetType` (e.g. `employee.givenName`, `jobPosition.manager`). It is readable on that resource and on `employee-attributes` alike.\n- `extension`: the value is only readable on `employee-attributes`. It is absent from every primary resource representation. This covers definitions created by your organization as well as definitions added by a Lucca application."
},
"isValueReadOnly": {
"type": "boolean",
"readOnly": true,
"description": "**Read-only.** Whether the values of this definition can be modified through the Lucca API.\n\n`false` only promises that an existing value may be modified: creating a value or deleting an occurrence have their own conditions. This flag describes what the account exposes, not the rights of the caller: a write on a `false` definition may still be denied with `403`."
},
"createdAt": {
"$ref": "#/components/schemas/createdAt"
},
"lastUpdatedAt": {
"$ref": "#/components/schemas/lastUpdatedAt"
}
}
}
],
"examples": [
{
"id": "e_tShirtSize",
"type": "employee-attribute-definition",
"url": "https://example.ilucca.net/lucca-api/employee-attribute-definitions/12",
"name": "T-shirt size",
"multipleValueHandling": null,
"schema": {
"$id": "/lucca-api/schemas/taxonomy-label-reference",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "taxonomy-label-reference",
"type": [
"object",
"null"
],
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "taxonomy-label",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
}
}
},
"taxonomy": {
"id": "45",
"type": "taxonomy",
"url": "https://example.ilucca.net/lucca-api/taxonomies/45"
},
"t9n": {
"name": {
"fr-FR": "Taille de t-shirt"
}
},
"targetType": "employee",
"category": "extension",
"isValueReadOnly": false,
"links": {}
}
]
},
"employee-attribute-definitions": {
"title": "employee-attribute-definitions",
"description": "Collection of [employee-attribute-definition](/api-reference/2024-11-01/employee-attributes/employee-attribute-definition) resources.",
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "employee-attribute-definitions"
},
"url": {
"type": "string",
"format": "uri"
},
"totalCount": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0,
"description": "Total number of employee-attribute-definition resources across all pages that satisfy query parameters."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employee-attribute-definition"
},
"maxItems": 1000
}
}
},
{
"$ref": "#/components/schemas/collection.links"
}
]
},
"employee-attribute-definition.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "No embedded resources on a employee-attribute-definition(s) response. Expect an empty object if embedded are requested.",
"type": [
"object",
"null"
]
}
}
},
"employee-attribute-definitions.read": {
"allOf": [
{
"$ref": "#/components/schemas/employee-attribute-definitions"
},
{
"$ref": "#/components/schemas/employee-attribute-definition.embedded"
}
]
},
"employee-attribute-definition.create": {
"title": "employee-attribute-definition",
"description": "employee-attribute-definition",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 3,
"maxLength": 255,
"pattern": "^e_",
"description": "Client-generated identifier. It must start with `e_` and must not be used by any other definition, sub-properties included."
},
"name": {
"type": "string",
"minLength": 1
},
"schema": {
"type": "object",
"description": "JSON schema of the attribute value, expressed by referencing base schemas. Two forms are accepted:\n\n- a single value: `{ \"$ref\": \"/lucca-api/schemas/\" }`;\n- an object value: `{ \"type\": \"object\", \"properties\": { \"\": { \"$ref\": \"/lucca-api/schemas/\" } } }`, where each property is described in `propertyDescriptions`.\n\nThe `schema` returned by GET embeds the referenced schemas: it cannot be sent back as is."
},
"propertyDescriptions": {
"type": [
"object",
"null"
],
"description": "Required whenever this definition schema is of type \"object\". \nThis property is a dictionary whose keys are the name of the schema object properties.",
"additionalProperties": {
"type": "object",
"required": [
"name",
"sortOrder"
],
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"taxonomy": {
"anyOf": [
{
"$ref": "#/components/schemas/taxonomy-reference"
},
{
"type": "null"
}
]
},
"sortOrder": {
"type": "integer",
"minimum": 0
},
"t9n": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/components/schemas/t9n"
}
}
}
}
}
},
"taxonomy": {
"title": "taxonomy-reference",
"description": "Reference to a taxonomy.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
"t9n": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/components/schemas/t9n"
}
}
},
"multipleValueHandling": {
"description": "Behavior regarding multiple extension values per single extended resource. When `null`, then only a single extension can exist for any extended resource. Multiple extensions may be accepted otherwise.\n\nExample: \"employee's children\" would accept multiple value, when \"employee's blood type\" would not.",
"type": [
"object",
"null"
],
"required": [
"sorting"
],
"properties": {
"sorting": {
"description": "In case of multiple extensions per resource, how should the client sort them (direction)?",
"type": "string",
"enum": [
"ascending",
"descending"
]
},
"sortingProperty": {
"description": "Not null for \"object\" schemas, in which case it points to the object property clients should sort extensions on: `extension.value[{sortingProperty}]`.\nNull otherwise, in which case clients are expected to sort on the actual `extension.value`.",
"type": [
"string",
"null"
]
}
}
}
},
"required": [
"id",
"name",
"schema"
]
},
"employee-attribute-definition.read": {
"allOf": [
{
"$ref": "#/components/schemas/employee-attribute-definition"
},
{
"$ref": "#/components/schemas/employee-attribute-definition.embedded"
}
]
},
"employee-attribute-definition.update": {
"title": "employee-attribute-definition",
"description": "employee-attribute-definition",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"schema": {
"type": "object",
"description": "JSON schema of the attribute value, in the same form as on creation. Its base schema cannot change: for an object value, every existing property must be kept with the same base schema, and only new properties can be added."
},
"propertyDescriptions": {
"type": [
"object",
"null"
],
"description": "Required whenever this definition schema is of type \"object\". \nThis property is a dictionary whose keys are the name of the schema object properties.",
"additionalProperties": {
"type": "object",
"required": [
"name",
"sortOrder"
],
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"taxonomy": {
"anyOf": [
{
"$ref": "#/components/schemas/taxonomy-reference"
},
{
"type": "null"
}
]
},
"sortOrder": {
"type": "integer",
"minimum": 0
},
"t9n": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/components/schemas/t9n"
}
}
}
}
}
},
"isArchived": {
"$ref": "#/components/schemas/isArchived"
},
"t9n": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/components/schemas/t9n"
}
}
},
"multipleValueHandling": {
"description": "Behavior regarding multiple extension values per single extended resource. When `null`, then only a single extension can exist for any extended resource. Multiple extensions may be accepted otherwise.\n\nExample: \"employee's children\" would accept multiple value, when \"employee's blood type\" would not.",
"type": [
"object",
"null"
],
"required": [
"sorting"
],
"properties": {
"sorting": {
"description": "In case of multiple extensions per resource, how should the client sort them (direction)?",
"type": "string",
"enum": [
"ascending",
"descending"
]
},
"sortingProperty": {
"description": "Not null for \"object\" schemas, in which case it points to the object property clients should sort extensions on: `extension.value[{sortingProperty}]`.\nNull otherwise, in which case clients are expected to sort on the actual `extension.value`.",
"type": [
"string",
"null"
]
}
}
}
}
},
"collection": {
"title": "collection",
"description": "collection",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"totalCount": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0,
"description": "Total number of items across all pages that satisfy query parameters."
},
"items": {
"type": "array",
"minItems": 0,
"maxItems": 1000,
"description": "Items of this paginated list. May be partial and/or stale representations.",
"items": {
"type": "object"
}
}
}
},
"employee-attribute-definition-reference": {
"title": "employee-attribute-definition-reference",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "employee-attribute-definition",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
}
}
},
"employee-attribute": {
"title": "employee-attribute",
"description": "An employee-attribute represents a single property value of an employee or any of their directly related resources.\n\nIt can be:\n- a property of the [employee](/api-reference/2024-11-01/employees/employee) resource;\n- a property of their [employment](/api-reference/2024-11-01/employments/employment) resources;\n- a property of their [job-position](/api-reference/2024-11-01/employments/job-position) resource;\n- an extension property of any of these resources, either user-defined or application-defined.\n\nSuch representation makes it possible to retrieve all attributes of an employee in a uniform manner.",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "employee-attribute"
},
"url": {
"type": "string",
"format": "uri"
},
"definition": {
"$ref": "#/components/schemas/employee-attribute-definition-reference"
},
"employee": {
"$ref": "#/components/schemas/employee-reference"
},
"employment": {
"oneOf": [
{
"$ref": "#/components/schemas/employment-reference"
},
{
"type": "null"
}
]
},
"jobPosition": {
"oneOf": [
{
"$ref": "#/components/schemas/job-position-reference"
},
{
"type": "null"
}
]
},
"applicability": {
"description": "The time window during which this attribute value applies to the employee.\n\nTwo periods are exposed side by side:\n\n- `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.\n- `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.\n\nA `null` lower bound must be interpreted as \"since the beginning of time\", and a `null` upper bound as \"until the end of time\".\n\nIf the attribute has no temporal dimension (e.g. `employee.givenName`, `e_tShirtSize`), all four dates are `null`. It must be interpreted as \"applies indefinitely\".\n\nThe `applicability.asOf` and `applicability.strictAsOf` query parameters can be used to filter by date, on the computed and on the strict period respectively.",
"type": [
"null",
"object"
],
"additionalProperties": false,
"properties": {
"start": {
"description": "Inclusive lower bound of the computed period, which fills the gaps between consecutive resources. Null means no lower limit (\"since the beginning of time\").",
"type": [
"null",
"string"
],
"format": "date",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$"
},
"end": {
"description": "Inclusive upper bound of the computed period, which fills the gaps between consecutive resources. Null means no upper limit (\"until the end of time\").",
"type": [
"null",
"string"
],
"format": "date",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$"
},
"strictStart": {
"description": "Inclusive lower bound of the strict period, inherited from the source resource without gap filling. Null means no lower limit (\"since the beginning of time\").",
"type": [
"null",
"string"
],
"format": "date",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$"
},
"strictEnd": {
"description": "Inclusive upper bound of the strict period, inherited from the source resource without gap filling. Null means no upper limit (\"until the end of time\").",
"type": [
"null",
"string"
],
"format": "date",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$"
}
}
},
"value": {
"type": [
"null",
"boolean",
"number",
"string",
"object",
"array"
],
"items": {
"type": [
"null",
"boolean",
"number",
"string",
"object"
]
}
},
"createdAt": {
"$ref": "#/components/schemas/createdAt"
},
"lastUpdatedAt": {
"$ref": "#/components/schemas/lastUpdatedAt"
},
"links": {
"type": "object",
"additionalProperties": false,
"properties": {
"files": {
"$ref": "#/components/schemas/file-links"
}
}
}
},
"example": {
"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": {}
}
},
"employee-attributes": {
"title": "employee-attributes",
"description": "A collection of [employee-attribute](/api-reference/2024-11-01/employee-attributes/employee-attribute) objects.",
"allOf": [
{
"$ref": "#/components/schemas/collection"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "employee-attributes"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employee-attribute"
}
}
}
},
{
"$ref": "#/components/schemas/collection.links"
}
]
},
"taxonomy-label": {
"title": "taxonomy-label",
"description": "Represents a label of a taxonomy, which is used to classify resources (e.g. employees).",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "taxonomy-label"
},
"url": {
"type": "string",
"format": "uri"
},
"taxonomy": {
"$ref": "#/components/schemas/taxonomy-reference"
},
"name": {
"type": "string",
"minLength": 1
},
"remoteId": {
"type": [
"null",
"string"
],
"minLength": 1
},
"applicabilitySchema": {
"description": "JSON schema of the applicable resources this taxonomy label only applies to.",
"type": [
"null",
"object"
]
},
"createdAt": {
"$ref": "#/components/schemas/createdAt"
},
"lastUpdatedAt": {
"$ref": "#/components/schemas/lastUpdatedAt"
},
"isArchived": {
"$ref": "#/components/schemas/isArchived"
},
"lastArchivedAt": {
"$ref": "#/components/schemas/lastArchivedAt"
},
"t9n": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/components/schemas/t9n"
}
}
},
"links": {
"type": "object",
"additionalProperties": false
}
},
"example": {
"id": "984",
"type": "taxonomy-label",
"url": "https://example.ilucca.net/lucca-api/taxonomy-labels/984",
"taxonomy": {
"id": "45",
"type": "taxonomy",
"url": "https://example.ilucca.net/lucca-api/taxonomies/45"
},
"name": "XL",
"remoteId": "tshirtSize.extraLarge",
"createdAt": "2025-01-23T19:45:23Z",
"lastUpdatedAt": "2025-01-23T19:45:23Z",
"isArchived": false,
"lastArchivedAt": null,
"t9n": {},
"links": {}
}
},
"employee-attribute.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "Embeds the representation of resources related to the employee-attribute(s).\n\nOnly returned if requested by the API client: `?include=embedded`.",
"type": [
"object",
"null"
],
"properties": {
"employee-attribute-definition": {
"type": [
"object",
"null"
],
"description": "The employee-attribute-definitions associated with the employee-attribute(s).\n\nStructured as a dictionary of [employee-attribute-definitions](/api-reference/2024-11-01/employee-attributes/employee-attribute-definition) indexed by their ID.",
"additionalProperties": {
"$ref": "#/components/schemas/employee-attribute-definition"
}
},
"taxonomy-label": {
"type": [
"object",
"null"
],
"description": "The taxonomy labels referenced by the employee-attribute(s).\n\nStructured as a dictionary of [taxonomy labels](/api-reference/2024-11-01/taxonomies/taxonomy-label) indexed by their ID.",
"additionalProperties": {
"$ref": "#/components/schemas/taxonomy-label"
}
}
}
}
}
},
"employee-attributes.read": {
"allOf": [
{
"$ref": "#/components/schemas/employee-attributes"
},
{
"$ref": "#/components/schemas/employee-attribute.embedded"
}
]
},
"employee-attribute.create": {
"title": "employee-attribute",
"description": "An employee-attribute represents a single property value of an employee or any of their directly related resources.\n\nIt can be:\n- a property of the [employee](/api-reference/2024-11-01/employees/employee) resource;\n- a property of their [employment](/api-reference/2024-11-01/employments/employment) resources;\n- a property of their [job-position](/api-reference/2024-11-01/employments/job-position) resource;\n- an extension property of any of these resources, either user-defined or application-defined.\n\nSuch representation makes it possible to retrieve all attributes of an employee in a uniform manner.",
"type": "object",
"properties": {
"definition": {
"title": "employee-attribute-definition-reference",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
"employee": {
"title": "employee-reference",
"description": "Reference to an employee resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
"employment": {
"description": "Only for a definition whose `targetType` is `employment` or `job-position`.",
"oneOf": [
{
"title": "employment-reference",
"description": "Reference to an [employment](/api-reference/2024-11-01/employments/employment) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
{
"type": "null"
}
]
},
"jobPosition": {
"description": "Only for a definition whose `targetType` is `job-position`.",
"oneOf": [
{
"title": "job-position-reference",
"description": "Reference to a [job-position](/api-reference/2024-11-01/employments/job-position) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
{
"type": "null"
}
]
},
"value": {
"type": [
"null",
"boolean",
"number",
"string",
"object",
"array"
],
"items": {
"type": [
"null",
"boolean",
"number",
"string",
"object"
]
}
}
},
"required": [
"definition",
"employee",
"value"
]
},
"employee-attribute.read": {
"allOf": [
{
"$ref": "#/components/schemas/employee-attribute"
},
{
"$ref": "#/components/schemas/employee-attribute.embedded"
}
]
},
"employee-attribute.update": {
"title": "employee-attribute",
"description": "An employee-attribute represents a single property value of an employee or any of their directly related resources.\n\nIt can be:\n- a property of the [employee](/api-reference/2024-11-01/employees/employee) resource;\n- a property of their [employment](/api-reference/2024-11-01/employments/employment) resources;\n- a property of their [job-position](/api-reference/2024-11-01/employments/job-position) resource;\n- an extension property of any of these resources, either user-defined or application-defined.\n\nSuch representation makes it possible to retrieve all attributes of an employee in a uniform manner.",
"type": "object",
"properties": {
"value": {
"type": [
"null",
"boolean",
"number",
"string",
"object",
"array"
],
"items": {
"type": [
"null",
"boolean",
"number",
"string",
"object"
]
}
}
}
},
"portrait": {
"title": "portrait",
"description": "JSON representation of the image file that represents an employee.\n\nYou can also retrieve the actual image file through content negotiation: `Accept: image/*`.",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "portrait"
},
"url": {
"type": "string",
"format": "uri"
},
"employee": {
"$ref": "#/components/schemas/employee-reference"
},
"fileName": {
"type": "string",
"minLength": 1
},
"contentType": {
"type": "string",
"description": "Examples may be: 'image/jpeg', 'image/png', 'image/bmp', 'image/gif', 'image/tiff', etc..."
},
"createdAt": {
"$ref": "#/components/schemas/createdAt"
},
"links": {
"type": [
"object",
"null"
],
"additionalProperties": false
}
},
"example": {
"id": "2face165-5345-4cf3-ab05-5421a6b19df2",
"type": "portrait",
"url": "https://example.ilucca.net/lucca-api/portraits/2face165-5345-4cf3-ab05-5421a6b19df2",
"employee": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"fileName": "jdoe-800.jpeg",
"contentType": "image/jpeg",
"links": {}
}
},
"portrait.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "No embedded resources on a portrait(s) response. Expect an empty object if embedded are requested.",
"type": [
"object",
"null"
]
}
}
},
"portrait.read": {
"allOf": [
{
"$ref": "#/components/schemas/portrait"
},
{
"$ref": "#/components/schemas/portrait.embedded"
}
]
},
"legal-gender": {
"description": "\"Unknown\" is equivalent to \"unspecified\" or \"null\".\n\n\"Diverse\" may be legally acknowledged in some countries (e.g. Germany).",
"type": "string",
"enum": [
"unknown",
"male",
"female",
"diverse"
],
"default": "unknown",
"examples": [
"unknown"
]
},
"insurance-number": {
"title": "insurance-number",
"description": "Validation depends on selected format. Value for \"other\" format is not validated.",
"type": "object",
"properties": {
"format": {
"type": "string",
"enum": [
"frenchSSN",
"swissSSN",
"other"
]
},
"value": {
"type": "string"
}
}
},
"bank-account": {
"description": "Represents a bank account in any format, including IBAN, SWIFT, and region-specific routing details.",
"type": "object",
"additionalProperties": false,
"required": [
"format"
],
"properties": {
"format": {
"type": "string",
"enum": [
"other",
"iban"
],
"default": "other"
},
"bankName": {
"type": [
"null",
"string"
],
"description": "Optional name of the bank.",
"minLength": 1,
"maxLength": 255
},
"accountIdentifier": {
"type": [
"null",
"string"
],
"description": "When format is `iban`, then an IBAN is expected. Otherwise, may be any local / domestic bank account number.",
"minLength": 1,
"maxLength": 255
},
"bankIdentifier": {
"type": [
"null",
"string"
],
"description": "When format is `iban`, then `null` is expected, given that an IBAN already identifies the bank establishment. Otherwise, may be any local bank identifier / routing number or international SWIFT BIC code.",
"minLength": 1,
"maxLength": 255
}
},
"examples": [
{
"format": "iban",
"bankName": "BNP Paribas",
"accountIdentifier": "FR7630006000011234567890189",
"bankIdentifier": null
},
{
"format": "other",
"bankName": "JPMorgan Chase Bank",
"accountIdentifier": "123456789",
"bankIdentifier": "021000021"
}
]
},
"employee-personal-record": {
"title": "employee-personal-record",
"x-tags": [
"employees"
],
"description": "The employee-personal-record resource represents the confidential attributes of an [employee](/api-reference/2024-11-01/employees/employee), i.e. sensitive personal information about them which gives details of their background, identity proofs, and qualifications.",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "employee-personal-record"
},
"url": {
"type": "string",
"format": "uri"
},
"employee": {
"$ref": "#/components/schemas/employee-reference"
},
"title": {
"description": "- `unknown`: Not indicated. Equivalent to a technical `null`.\n- `mister`: Either married or unmarried man. French: 'Monsieur'.\n- `miss`: Unmarried woman. French: 'Mademoiselle'.",
"type": "string",
"enum": [
"unknown",
"mister",
"miss"
],
"default": "unknown"
},
"legalGender": {
"$ref": "#/components/schemas/legal-gender"
},
"maritalStatus": {
"description": "- `unknown`: Not indicated. Equivalent to a technical `null`.\n- `single`: Neither married nor in a civil partnership.\n- `civilPartner`: Non-religious legal partnership. French: 'PACS'.\n- `married`: Married.\n- `divorced`: Divorced.\n- `widowed`: Widowed.\n- `cohabitant`: Living with a partner without legal union. French: 'Concubinage'.",
"type": "string",
"enum": [
"unknown",
"single",
"civilPartner",
"married",
"divorced",
"widowed",
"cohabitant"
],
"default": "unknown"
},
"birthDate": {
"type": [
"null",
"string"
],
"format": "date",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$"
},
"insuranceNumber": {
"oneOf": [
{
"$ref": "#/components/schemas/insurance-number"
},
{
"type": "null"
}
]
},
"nationalitiesCountryCodes": {
"description": "Array of ISO 3166-1 alpha-3 country codes.",
"type": "array",
"maxItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/country-code"
}
},
"bankAccount": {
"oneOf": [
{
"$ref": "#/components/schemas/bank-account"
},
{
"type": "null"
}
]
},
"phoneNumber": {
"description": "Personal phone number of the employee.",
"oneOf": [
{
"$ref": "#/components/schemas/phone"
},
{
"type": "null"
}
]
},
"email": {
"description": "Personal email address of the employee.",
"type": [
"null",
"string"
],
"format": "idn-email",
"minLength": 3,
"maxLength": 255
},
"createdAt": {
"$ref": "#/components/schemas/createdAt"
},
"lastUpdatedAt": {
"$ref": "#/components/schemas/lastUpdatedAt"
},
"links": {
"type": "object",
"additionalProperties": false
}
},
"example": {
"id": "897",
"type": "employee-personal-record",
"url": "https://example.ilucca.net/lucca-api/employee-personal-records/897",
"employee": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"title": "mister",
"legalGender": "male",
"maritalStatus": "single",
"birthDate": "1989-12-21",
"insuranceNumber": {
"format": "frenchSSN",
"value": "1760774865895 37"
},
"nationalitiesCountryCodes": [
"FRA"
],
"bankAccount": {
"format": "iban",
"bankName": "BNP Paribas",
"accountIdentifier": "FR7630006000011234567890189",
"bankIdentifier": null
},
"phoneNumber": "+33456789634",
"email": "jdoe13@gmail.com",
"links": {}
}
},
"employee-personal-records": {
"title": "employee-personal-records",
"description": "A collection of [employee-personal-record](/api-reference/2024-11-01/employees/employee-personal-record) objects.",
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "employee-personal-records"
},
"url": {
"type": "string",
"format": "uri"
},
"totalCount": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0,
"description": "Total number of employee-personal-record resources across all pages that satisfy query parameters."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employee-personal-record"
},
"maxItems": 1000
}
}
},
{
"$ref": "#/components/schemas/collection.links"
}
]
},
"employee-personal-record.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "Embeds the representation of resources related to the employee-personal-record(s).\n\nOnly returned if requested by the API client: `?include=embedded`.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"employee": {
"description": "Employees these are the personal-record(s) of (cf. `employeePersonalRecord.employee`).\n\nStructured as a dictionary of [employees](/api-reference/2024-11-01/employees/employee) indexed by ID.",
"type": [
"object",
"null"
],
"additionalProperties": {
"$ref": "#/components/schemas/employee"
}
}
}
}
}
},
"employee-personal-records.read": {
"allOf": [
{
"$ref": "#/components/schemas/employee-personal-records"
},
{
"$ref": "#/components/schemas/employee-personal-record.embedded"
}
]
},
"employee-personal-record.read": {
"allOf": [
{
"$ref": "#/components/schemas/employee-personal-record"
},
{
"$ref": "#/components/schemas/employee-personal-record.embedded"
}
]
},
"employments": {
"title": "employments",
"description": "A collection of [employment](/api-reference/2024-11-01/employments/employment) objects.",
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "employments"
},
"url": {
"type": "string",
"format": "uri"
},
"totalCount": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0,
"description": "Total number of employment resources across all pages that satisfy query parameters."
},
"items": {
"type": "array",
"minItems": 0,
"maxItems": 1000,
"description": "Paginated list of employment resources.",
"items": {
"$ref": "#/components/schemas/employment"
}
}
}
},
{
"$ref": "#/components/schemas/collection.links"
}
]
},
"probationary-period": {
"title": "probationary-period",
"description": "A probationary-period represents a period during which an employment's employee under scrutiny to find out if they are the right fit and have sufficient skills for the position.\n\nOnly one probationary-period may be created for a single [employment](/api-reference/2024-11-01/employments/employment).\n\nA probationary-period start date `startsOn` is read-only as it must always be equal to the related employment start date `start.date`.",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "probationary-period"
},
"url": {
"type": "string",
"format": "uri"
},
"employment": {
"$ref": "#/components/schemas/employment-reference",
"description": "The [employment](/api-reference/2024-11-01/employments/employment) this probationary-period applies to. Cannot be modified once the probationary-period is created."
},
"startsOn": {
"description": "**Read-only**. Equal to the related employment start date.",
"type": "string",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$",
"format": "date"
},
"endsOn": {
"description": "**Read-only**. End date of the probationary-period, equal to `extendedEndsOn` if not null, and `initialEndsOn` otherwise.",
"type": "string",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$",
"format": "date"
},
"initialEndsOn": {
"description": "Initial end date of the probationary-period. **Required** upon creation.",
"type": "string",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$",
"format": "date"
},
"extendedEndsOn": {
"description": "End date of the probationary-period in case it was extended.",
"type": [
"null",
"string"
],
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$",
"format": "date"
},
"createdAt": {
"$ref": "#/components/schemas/createdAt"
},
"lastUpdatedAt": {
"$ref": "#/components/schemas/lastUpdatedAt"
},
"links": {
"type": "object",
"additionalProperties": false
}
},
"example": {
"id": "8721",
"type": "probationary-period",
"url": "https://example.ilucca.net/lucca-api/probationary-periods/8721",
"employment": {
"id": "4561",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/4561"
},
"startsOn": "2024-02-01",
"endsOn": "2024-07-31",
"initialEndsOn": "2024-04-30",
"extendedEndsOn": "2024-07-31",
"createdAt": "2024-03-24T08:21:35.001Z",
"lastUpdatedAt": "2024-03-24T08:21:35.001Z",
"links": {}
}
},
"employment.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "Embeds the representation of resources related to the employment(s).\n\nOnly returned if requested by the API client: `?include=embedded`.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"employee": {
"description": "Employees these are the employment(s) of (cf. `employment.employee`).\n\nStructured as a dictionary of [employees](/api-reference/2024-11-01/employees/employee) indexed by their ID.",
"type": [
"object",
"null"
],
"additionalProperties": {
"$ref": "#/components/schemas/employee"
}
},
"legal-entity": {
"description": "Legal-entities these employment(s) are signed with (cf. `employment.legalEntity`).\n\nStructured as a dictionary of [legal-entities](/api-reference/2024-11-01/organization/legal-entity) indexed by their ID.",
"type": [
"object",
"null"
],
"additionalProperties": {
"$ref": "#/components/schemas/legal-entity"
}
},
"job-position": {
"description": "Job-positions of these employment(s) (cf. `links.jobPositions`).\n\nStructured as a dictionary of [job-positions](/api-reference/2024-11-01/employments/job-position) indexed by their ID.",
"type": [
"object",
"null"
],
"additionalProperties": {
"$ref": "#/components/schemas/job-position"
}
},
"probationary-period": {
"description": "Probationary-periods of these employment(s) (cf. `links.probationaryPeriods`).\n\nStructured as a dictionary of [probationary-periods](/api-reference/2024-11-01/employments/probationary-period) indexed by their ID.",
"type": [
"object",
"null"
],
"additionalProperties": {
"$ref": "#/components/schemas/probationary-period"
}
}
}
}
}
},
"employments.read": {
"allOf": [
{
"$ref": "#/components/schemas/employments"
},
{
"$ref": "#/components/schemas/employment.embedded"
}
]
},
"employment.read": {
"allOf": [
{
"$ref": "#/components/schemas/employment"
},
{
"$ref": "#/components/schemas/employment.embedded"
}
]
},
"employment.update": {
"title": "employment",
"description": "The employment resource represents a relationship between an [employee](/api-reference/2024-11-01/employees/employee) and a [legal-entity](/api-reference/2024-11-01/organization/legal-entity) over a continuous period. It may actually represent a work contract, an internship agreement, a contractor's contract, etc...\n\nThe actual job of the employee is defined through the [job-position](/api-reference/2024-11-01/employments/job-position) resource, which references an employment. Over the course of his/her employment, the employee may occupy several job-positions.",
"x-tags": [
"employees"
],
"type": "object",
"properties": {
"remoteId": {
"type": [
"null",
"string"
],
"minLength": 1,
"maxLength": 200,
"description": "Resource identifier in a third-party system."
},
"start": {
"type": "object",
"required": [
"date"
],
"additionalProperties": false,
"properties": {
"date": {
"description": "Date of the first day (included) of this employment.",
"type": "string",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$",
"format": "date"
}
}
},
"end": {
"type": [
"null",
"object"
],
"additionalProperties": false,
"required": [
"date"
],
"properties": {
"date": {
"description": "Date of the last day (included) of this employment. After this date, this employment is considered terminated.\n\nLeave `null` for permanent employments (as long as the employee is kept), and set the date of the last day in case of a fixed-term employment.\n\nEndsOn date must be greater or equal than StartsOn date.",
"type": "string",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$",
"format": "date"
}
}
},
"document": {
"oneOf": [
{
"title": "file-reference",
"description": "Reference to a [file](/api-reference/2024-11-01/files/file) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
{
"type": "null"
}
]
},
"template": {
"title": "employment-template-reference",
"description": "Reference to an [employment-template](/api-reference/2024-11-01/employments/employment-template) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
}
}
},
"employment-template": {
"title": "employment-template",
"description": "Type of employment (configurable).\n\nIn France: \"CDI\", \"CDD\", \"CTT\", \"Convention de stage\", \"Contrat d'apprentissage\", etc...",
"x-tags": [
"Employments"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "employment-template"
},
"url": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string",
"minLength": 1
},
"legalEntities": {
"description": "Reserve this employment-template to a subset of legal-entities.\nLeave empty if this template should be available to ALL legal-entities.",
"type": "array",
"items": {
"$ref": "#/components/schemas/legal-entity-reference"
}
},
"term": {
"$ref": "#/components/schemas/employment-term"
},
"audience": {
"type": "string",
"enum": [
"employee",
"student",
"external",
"elected",
"appointee",
"associate",
"volunteer",
"other",
"apprentice"
],
"default": "employee"
},
"isArchived": {
"type": "boolean",
"description": "**Read-only.** Whether this employment-template is archived. Archived employment-templates should not be used for new employments."
},
"t9n": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"$ref": "#/components/schemas/t9n"
}
}
},
"createdAt": {
"$ref": "#/components/schemas/createdAt"
},
"lastUpdatedAt": {
"$ref": "#/components/schemas/lastUpdatedAt"
},
"links": {
"type": "object",
"additionalProperties": false,
"properties": {
"extensionDefinitions": {
"$ref": "#/components/schemas/link"
}
}
}
},
"example": {
"id": "12",
"type": "employment-template",
"url": "https://example.ilucca.net/lucca-api/employment-templates/12",
"title": "Internship",
"legalEntities": [
{
"id": "123",
"type": "legal-entity",
"url": "https://example.ilucca.net/lucca-api/legal-entities/123"
}
],
"term": "fixed",
"audience": "student",
"isArchived": false,
"t9n": {
"title": {
"fr-FR": "Convention de stage"
}
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"extensionDefinitions": {
"href": "https://example.ilucca.net/lucca-api/employee-attribute-definitions?category=extension"
}
}
}
},
"employment-templates": {
"title": "employment-templates",
"description": "A collection of [employment-template](/api-reference/2024-11-01/employments/employment-template) objects.",
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "employment-templates"
},
"url": {
"type": "string",
"format": "uri"
},
"totalCount": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0,
"description": "Total number of employment-template resources across all pages that satisfy query parameters."
},
"items": {
"type": "array",
"minItems": 0,
"maxItems": 1000,
"items": {
"$ref": "#/components/schemas/employment-template"
}
}
}
},
{
"$ref": "#/components/schemas/collection.links"
}
]
},
"employment-template.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "No embedded resources on a employment-template(s) response. Expect an empty object if embedded are requested.",
"type": [
"object",
"null"
]
}
}
},
"employment-templates.read": {
"allOf": [
{
"$ref": "#/components/schemas/employment-templates"
},
{
"$ref": "#/components/schemas/employment-template.embedded"
}
]
},
"employment-template.read": {
"allOf": [
{
"$ref": "#/components/schemas/employment-template"
},
{
"$ref": "#/components/schemas/employment-template.embedded"
}
]
},
"job-positions": {
"title": "job-positions",
"description": "A collection of [job-position](/api-reference/2024-11-01/employments/job-position) objects.",
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "job-positions"
},
"url": {
"type": "string",
"format": "uri"
},
"totalCount": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0,
"description": "Total number of job-position resources across all pages that satisfy query parameters."
},
"items": {
"type": "array",
"minItems": 0,
"maxItems": 1000,
"description": "Paginated list of job-position resources.",
"items": {
"$ref": "#/components/schemas/job-position"
}
}
}
},
{
"$ref": "#/components/schemas/collection.links"
}
]
},
"job-position.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "Embeds the representation of resources related to the job-position(s).\n\nOnly returned if requested by the API client: `?include=embedded`.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"department": {
"description": "Department these job-position(s) are in (cf. `jobPosition.department`).\n\nStructured as a dictionary of [departments](/api-reference/2024-11-01/organization/department) indexed by their ID.",
"type": [
"object",
"null"
],
"additionalProperties": {
"$ref": "#/components/schemas/department"
}
},
"job-qualification": {
"description": "Job-qualifications these job-position(s) are practicing (cf. `jobPosition.jobQualification`).\n\nStructured as a dictionary of [job-qualifications](/api-reference/2024-11-01/employee-job-qualifications/job-qualification) indexed by their ID.",
"type": [
"object",
"null"
],
"additionalProperties": {
"$ref": "#/components/schemas/job-qualification"
}
},
"employee": {
"description": "Employees these job-position(s) belong to (cf. `jobPosition.employment.employee`).\n\nStructured as a dictionary of [employees](/api-reference/2024-11-01/employees/employee) indexed by their ID.",
"type": [
"object",
"null"
],
"additionalProperties": {
"$ref": "#/components/schemas/employee"
}
},
"employment": {
"description": "Employments these job-position(s) belong to (cf. `jobPosition.employment`).\n\nStructured as a dictionary of [employment](/api-reference/2024-11-01/employments/employment) indexed by their ID.",
"type": [
"object",
"null"
],
"additionalProperties": {
"$ref": "#/components/schemas/employment"
}
},
"occupation-category": {
"description": "Occupation categories these job-position(s) are practicing (cf. `jobPosition.occurpationCategory`).\n\nStructured as a dictionary of [occupation-category](/api-reference/2024-11-01/employee-occupation-categories/occupation-category) indexed by their ID.",
"type": [
"object",
"null"
],
"additionalProperties": {
"$ref": "#/components/schemas/occupation-category"
}
},
"business-establishment": {
"description": "Business-establishments these job-position(s) are in (cf. `jobPosition.businessEstablishment`).\n\nStructured as a dictionary of [business-establishments](/api-reference/2024-11-01/organization/business-establishment) indexed by their ID.",
"type": [
"object",
"null"
],
"additionalProperties": {
"$ref": "#/components/schemas/business-establishment"
}
}
}
}
}
},
"job-positions.read": {
"allOf": [
{
"$ref": "#/components/schemas/job-positions"
},
{
"$ref": "#/components/schemas/job-position.embedded"
}
]
},
"job-position.read": {
"allOf": [
{
"$ref": "#/components/schemas/job-position"
},
{
"$ref": "#/components/schemas/job-position.embedded"
}
]
},
"job-position.update": {
"title": "job-position",
"x-tags": [
"Employees"
],
"description": "The job position represents a stage in an [employee](/api-reference/2024-11-01/employees/employee)'s career during one of their [employment](/api-reference/2024-11-01/employments/employment) in a given [business-establishment](/api-reference/2024-11-01/organization/business-establishment).\n\nIt therefore outlines the attributes of the person as a professional (qualifications) and their role in the company as well as who's their manager.",
"type": "object",
"properties": {
"remoteId": {
"minLength": 1,
"maxLength": 1024,
"description": "Resource identifier in a third-party system. No unicity constraint: two job-positions may have the same value.",
"type": [
"null",
"string"
]
},
"startsOn": {
"description": "Effective date of this job-position for this employee.\n\nCannot be outside the range of the employment.\n\nThe `startsOn` of the first job-position of an employment follows the employment `start.date`: change the employment start instead, as updating it directly returns a `400`.\n\nThis should be considered \"applicable\" based on the related [employment](/api-reference/2024-11-01/employments/employment) business-establishment timezone.",
"type": "string",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$",
"format": "date"
},
"businessEstablishment": {
"title": "business-establishment-reference",
"description": "Reference to a [business-establishment](/api-reference/2024-11-01/organization/business-establishment) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
}
},
"jobTitle": {
"description": "Short description of the job occupied by this employee.",
"type": [
"null",
"string"
],
"maxLength": 1024,
"minLength": 1
},
"jobQualification": {
"oneOf": [
{
"title": "job-qualification-reference",
"description": "Reference to a [job-qualification](/api-reference/2024-11-01/employee-job-qualifications/job-qualification) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
{
"type": "null"
}
]
},
"manager": {
"oneOf": [
{
"title": "employee-reference",
"description": "Reference to an employee resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
}
},
{
"type": "null"
}
]
},
"occupationCategory": {
"oneOf": [
{
"title": "occupation-category-reference",
"description": "Reference to an [occupation-category](/api-reference/2024-11-01/employee-occupation-categories/occupation-category) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
{
"type": "null"
}
]
},
"workingTimeArrangement": {
"oneOf": [
{
"title": "working-time-arrangement-reference",
"description": "Reference to a working-time-arrangement resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
{
"type": "null"
}
]
},
"department": {
"title": "department-reference",
"description": "Reference to a [department](/api-reference/2024-11-01/organization/department) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
}
},
"document": {
"oneOf": [
{
"title": "file-reference",
"description": "Reference to a [file](/api-reference/2024-11-01/files/file) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
{
"type": "null"
}
]
},
"notes": {
"type": [
"null",
"string"
],
"maxLength": 500,
"description": "Optional notes about this job-position change."
},
"t9n": {
"type": "object",
"additionalProperties": false,
"properties": {
"jobTitle": {
"$ref": "#/components/schemas/t9n"
}
}
}
}
},
"probationary-periods": {
"title": "probationary-periods",
"description": "A collection of probationary-period objects.",
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "probationary-periods"
},
"url": {
"type": "string",
"format": "uri"
},
"totalCount": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0,
"description": "Total number of probationary-period resources across all pages that satisfy query parameters."
},
"items": {
"type": "array",
"minItems": 0,
"maxItems": 1000,
"items": {
"$ref": "#/components/schemas/probationary-period"
}
}
}
},
{
"$ref": "#/components/schemas/collection.links"
}
]
},
"probationary-period.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "No embedded resources on a probationary-period(s) response. Expect an empty object if embedded are requested.",
"type": [
"object",
"null"
]
}
}
},
"probationary-periods.read": {
"allOf": [
{
"$ref": "#/components/schemas/probationary-periods"
},
{
"$ref": "#/components/schemas/probationary-period.embedded"
}
]
},
"probationary-period.create": {
"title": "probationary-period",
"description": "A probationary-period represents a period during which an employment's employee under scrutiny to find out if they are the right fit and have sufficient skills for the position.\n\nOnly one probationary-period may be created for a single [employment](/api-reference/2024-11-01/employments/employment).\n\nA probationary-period start date `startsOn` is read-only as it must always be equal to the related employment start date `start.date`.",
"type": "object",
"properties": {
"employment": {
"title": "employment-reference",
"description": "Reference to an [employment](/api-reference/2024-11-01/employments/employment) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
"initialEndsOn": {
"description": "Initial end date of the probationary-period. **Required** upon creation.",
"type": "string",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$",
"format": "date"
},
"extendedEndsOn": {
"description": "End date of the probationary-period in case it was extended.",
"type": [
"null",
"string"
],
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$",
"format": "date"
}
},
"required": [
"employment",
"initialEndsOn"
]
},
"probationary-period.read": {
"allOf": [
{
"$ref": "#/components/schemas/probationary-period"
},
{
"$ref": "#/components/schemas/probationary-period.embedded"
}
]
},
"probationary-period.update": {
"title": "probationary-period",
"description": "A probationary-period represents a period during which an employment's employee under scrutiny to find out if they are the right fit and have sufficient skills for the position.\n\nOnly one probationary-period may be created for a single [employment](/api-reference/2024-11-01/employments/employment).\n\nA probationary-period start date `startsOn` is read-only as it must always be equal to the related employment start date `start.date`.",
"type": "object",
"properties": {
"initialEndsOn": {
"description": "Initial end date of the probationary-period. **Required** upon creation.",
"type": "string",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$",
"format": "date"
},
"extendedEndsOn": {
"description": "End date of the probationary-period in case it was extended.",
"type": [
"null",
"string"
],
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])$",
"format": "date"
}
}
},
"taxonomy.sortLabelsBy": {
"type": "string",
"enum": [
"id",
"name"
],
"default": "id",
"description": "`id` is equivalent to \"createdAt\"."
},
"taxonomy": {
"title": "taxonomy",
"description": "Represents a list of labels, which can be used to classify other resources.",
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "taxonomy"
},
"url": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string",
"minLength": 1
},
"sortLabelsBy": {
"$ref": "#/components/schemas/taxonomy.sortLabelsBy",
"description": "Indication to the client about how it should sort taxonomy-labels. Value can be interpolated as the expected value of the \"sort\" query parameter:\n`/lucca-api/taxonomy-labels?taxonomy.id={{taxonomy.id}}&sort={{taxonomy.sortLabelsBy}}`"
},
"createdAt": {
"$ref": "#/components/schemas/createdAt"
},
"lastUpdatedAt": {
"$ref": "#/components/schemas/lastUpdatedAt"
},
"t9n": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/components/schemas/t9n"
}
}
},
"links": {
"type": "object",
"additionalProperties": false
}
},
"example": {
"id": "45",
"type": "taxonomy",
"url": "https://example.ilucca.net/lucca-api/taxonomies/45",
"name": "T-shirt size",
"createdAt": "2025-01-23T19:45:23Z",
"lastUpdatedAt": "2025-01-23T19:45:23Z",
"t9n": {
"name": {
"fr-FR": "Taille de t-shirt."
}
},
"links": {}
}
},
"taxonomies": {
"title": "taxonomies",
"description": "A collection of [taxonomy](/api-reference/2024-11-01/taxonomies/taxonomy) objects.",
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "taxonomies"
},
"url": {
"type": "string",
"format": "uri"
},
"totalCount": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0,
"description": "Total number of taxonomy resources across all pages that satisfy query parameters."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/taxonomy"
},
"maxItems": 1000
}
}
},
{
"$ref": "#/components/schemas/collection.links"
}
]
},
"taxonomy.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "No embedded resources on a taxonomy(ies) response. Expect an empty object if embedded are requested.",
"type": [
"object",
"null"
],
"additionalProperties": false
}
}
},
"taxonomies.read": {
"allOf": [
{
"$ref": "#/components/schemas/taxonomies"
},
{
"$ref": "#/components/schemas/taxonomy.embedded"
}
]
},
"taxonomy.create": {
"title": "taxonomy",
"description": "Represents a list of labels, which can be used to classify other resources.",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"sortLabelsBy": {
"$ref": "#/components/schemas/taxonomy.sortLabelsBy",
"description": "Indication to the client about how it should sort taxonomy-labels. Value can be interpolated as the expected value of the \"sort\" query parameter:\n`/lucca-api/taxonomy-labels?taxonomy.id={{taxonomy.id}}&sort={{taxonomy.sortLabelsBy}}`"
},
"t9n": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/components/schemas/t9n"
}
}
}
},
"required": [
"name"
]
},
"taxonomy.read": {
"allOf": [
{
"$ref": "#/components/schemas/taxonomy"
},
{
"$ref": "#/components/schemas/taxonomy.embedded"
}
]
},
"taxonomy.update": {
"title": "taxonomy",
"description": "Represents a list of labels, which can be used to classify other resources.",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"sortLabelsBy": {
"$ref": "#/components/schemas/taxonomy.sortLabelsBy",
"description": "Indication to the client about how it should sort taxonomy-labels. Value can be interpolated as the expected value of the \"sort\" query parameter:\n`/lucca-api/taxonomy-labels?taxonomy.id={{taxonomy.id}}&sort={{taxonomy.sortLabelsBy}}`"
},
"t9n": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/components/schemas/t9n"
}
}
}
},
"required": [
"name"
]
},
"taxonomy-labels": {
"title": "taxonomy-labels",
"description": "A collection of [taxonomy-label](/api-reference/2024-11-01/taxonomies/taxonomy-label) objects.",
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "taxonomy-labels"
},
"url": {
"type": "string",
"format": "uri"
},
"totalCount": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0,
"description": "Total number of profession resources across all pages that satisfy query parameters."
},
"items": {
"type": "array",
"minItems": 0,
"maxItems": 1000,
"items": {
"$ref": "#/components/schemas/taxonomy-label"
}
}
}
},
{
"$ref": "#/components/schemas/collection.links"
}
]
},
"taxonomy-label.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "No embedded resources on a taxonomy-label(s) response. Expect an empty object if embedded are requested.",
"type": [
"object",
"null"
],
"additionalProperties": false
}
}
},
"taxonomy-labels.read": {
"allOf": [
{
"$ref": "#/components/schemas/taxonomy-labels"
},
{
"$ref": "#/components/schemas/taxonomy-label.embedded"
}
]
},
"taxonomy-label.create": {
"title": "taxonomy-label",
"description": "Represents a label of a taxonomy, which is used to classify resources (e.g. employees).",
"type": "object",
"properties": {
"taxonomy": {
"title": "taxonomy-reference",
"description": "Reference to a taxonomy.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
},
"name": {
"type": "string",
"minLength": 1
},
"remoteId": {
"type": [
"null",
"string"
],
"minLength": 1
},
"t9n": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/components/schemas/t9n"
}
}
}
},
"required": [
"name",
"taxonomy"
]
},
"taxonomy-label.read": {
"allOf": [
{
"$ref": "#/components/schemas/taxonomy-label"
},
{
"$ref": "#/components/schemas/taxonomy-label.embedded"
}
]
},
"taxonomy-label.update": {
"title": "taxonomy-label",
"description": "Represents a label of a taxonomy, which is used to classify resources (e.g. employees).",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"remoteId": {
"type": [
"null",
"string"
],
"minLength": 1
},
"isArchived": {
"$ref": "#/components/schemas/isArchived"
},
"t9n": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/components/schemas/t9n"
}
}
}
}
},
"public-holidays-calendar-reference": {
"title": "holidays-calendar-reference",
"description": "Reference to a [holidays-calendar](/api-reference/2024-11-01/public-holidays-calendars/public-holidays-calendar) resource.",
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "public-holidays-calendar"
},
"url": {
"type": "string",
"format": "uri"
}
}
},
"working-time-arrangement": {
"title": "working-time-arrangement",
"description": "A working-time-arrangement dictates the time management rules employees are subject to via their job-position:\n\n- indicates their contractual working time, i.e. how many hours / days they are paid for each week / year;\n- gives a full time equivalent ratio based on the the ratio between this contractual work duration and a \"full time work duration\";\n- provides a succession of work cycles that describe their usual daily working hours.",
"x-tags": [
"working-time-arrangements"
],
"required": [
"name"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "working-time-arrangement"
},
"url": {
"type": "string",
"format": "uri"
},
"name": {
"description": "Name of this working-time-arrangement.",
"type": "string",
"minLength": 1
},
"publicHolidaysCalendar": {
"description": "Reference to the public holidays calendar that applies to this working-time-arrangement.",
"$ref": "#/components/schemas/public-holidays-calendar-reference"
},
"isArchived": {
"$ref": "#/components/schemas/isArchived"
},
"links": {
"type": "object"
}
},
"example": {
"id": "237",
"type": "working-time-arrangement",
"url": "https://example.ilucca.net/lucca-api/working-time-arrangements/237",
"name": "Standard - 35H / week",
"publicHolidaysCalendar": {
"id": "3",
"type": "public-holidays-calendar",
"url": "https://example.ilucca.net/lucca-api/public-holidays-calendars/3"
},
"isArchived": false,
"links": {}
}
},
"working-time-arrangements": {
"title": "working-time-arrangements",
"description": "Collection of working-time-arrangement resources.",
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "working-time-arrangements"
},
"url": {
"type": "string",
"format": "uri"
},
"totalCount": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0,
"description": "Total number of working-time-arrangement resources across all pages that satisfy query parameters."
},
"items": {
"type": "array",
"minItems": 0,
"maxItems": 1000,
"items": {
"$ref": "#/components/schemas/working-time-arrangement"
}
}
}
},
{
"$ref": "#/components/schemas/collection.links"
}
]
},
"working-time-arrangement.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "No embedded resources on a working-time-arrangement(s) response. Expect an empty object if embedded are requested.",
"type": [
"null",
"object"
]
}
}
},
"working-time-arrangements.read": {
"allOf": [
{
"$ref": "#/components/schemas/working-time-arrangements"
},
{
"$ref": "#/components/schemas/working-time-arrangement.embedded"
}
]
},
"working-time-arrangement.read": {
"allOf": [
{
"$ref": "#/components/schemas/working-time-arrangement"
},
{
"$ref": "#/components/schemas/working-time-arrangement.embedded"
}
]
},
"event.topic": {
"description": "List of topics",
"oneOf": [
{
"type": "string",
"title": "test.created",
"const": "test.created"
},
{
"type": "string",
"title": "employee.created",
"const": "employee.created"
},
{
"type": "string",
"title": "employee.updated",
"const": "employee.updated"
},
{
"type": "string",
"title": "employment.created",
"const": "employment.created"
},
{
"type": "string",
"title": "employment.updated",
"const": "employment.updated"
},
{
"type": "string",
"title": "employment.deleted",
"const": "employment.deleted"
},
{
"type": "string",
"title": "job-position.created",
"const": "job-position.created"
},
{
"type": "string",
"title": "job-position.updated",
"const": "job-position.updated"
},
{
"type": "string",
"title": "job-position.deleted",
"const": "job-position.deleted"
},
{
"type": "string",
"title": "employee-attribute.created",
"const": "employee-attribute.created"
},
{
"type": "string",
"title": "employee-attribute.updated",
"const": "employee-attribute.updated"
},
{
"type": "string",
"title": "employee-attribute.deleted",
"const": "employee-attribute.deleted"
}
]
},
"event": {
"title": "event",
"description": "Represents a change made to the state of a resource.",
"x-tags": [
"Events"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique string identifier of this event."
},
"type": {
"type": "string",
"const": "event"
},
"url": {
"type": "string",
"format": "uri",
"description": "Absolute URL for the event resource."
},
"apiVersion": {
"type": "string",
"format": "date",
"description": "API version of the resource representation contained in data. Not to be confused with the API version of the representation of this present event, which is indicated in the `Api-Version` HTTP header."
},
"topic": {
"description": "Indicates which type of event occurred. Usually concatenates the name of the object type with the kind of change (\"created\", \"updated\" or \"deleted\").",
"examples": [
"employee.created"
],
"allOf": [
{
"$ref": "#/components/schemas/event.topic"
}
]
},
"occurredAt": {
"type": "string",
"format": "date-time",
"description": "Timezoned timestamp of the moment when this event occurred."
},
"source": {
"type": "string",
"format": "uri",
"description": "URL of the tenant. Ensures unicity of {source} + {id}."
},
"data": {
"type": "object",
"description": "Representation of the resource whose change triggered the event. Please note that this is the representation of the resource just after the change, and it may have changed again since then.",
"additionalProperties": true
},
"businessEstablishment": {
"description": "Business Establishment of the Resource in the Event, if there is one.",
"anyOf": [
{
"$ref": "#/components/schemas/business-establishment-reference"
},
{
"type": "null"
}
]
},
"previousAttributes": {
"description": "Only sent on `*.updated` event topics. Keys are the list of modified attributes. Values are the values of these attributes before the change.\n\nThis is only available for some resources. If a value in the dictionary is NULL, then it can either mean that the original value was NULL or that we can't retrieve them for this Resource.",
"type": "object",
"additionalProperties": true
},
"links": {
"type": "object",
"additionalProperties": false,
"properties": {
"retry": {
"type": "object",
"properties": {
"href": {
"type": "string",
"format": "uri"
}
}
}
}
}
},
"example": {
"id": "123",
"type": "event",
"url": "https://example.ilucca.net/lucca-api/events/123",
"apiVersion": "2024-01-01",
"topic": "employee.updated",
"occurredAt": "2024-02-01T09:34:23.001Z",
"source": "https://example.ilucca.net",
"businessEstablishment": {
"id": "12",
"type": "business-establishment",
"url": "https://example.ilucca.net/lucca-api/business-establishments/12"
},
"data": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416",
"remoteId": "00002345",
"portrait": {
"id": "2face165-5345-4cf3-ab05-5421a6b19df2",
"type": "portrait",
"url": "https://example.ilucca.net/lucca-api/portraits/2face165-5345-4cf3-ab05-5421a6b19df2"
},
"givenName": "Edward",
"familyName": "Atkinson",
"employeeNumber": "E000124",
"status": "active",
"email": "eatkinson@acme.corp",
"birthDay": {
"day": 22,
"month": 12
},
"phoneNumber": "+33145784512",
"applicableEmployment": {
"id": "154",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/154"
},
"applicableJobPosition": {
"id": "74",
"type": "job-position",
"url": "https://example.ilucca.net/lucca-api/job-positions/74"
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z"
},
"previousAttributes": {
"givenName": "Ed"
},
"links": {
"retry": {
"href": "https://example.ilucca.net/lucca-api/webhook-deliveries"
}
}
}
},
"events": {
"title": "events",
"description": "A collection of [event](/api-reference/2024-11-01/events/event) objects.",
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "events"
},
"url": {
"type": "string",
"format": "uri"
},
"totalCount": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0,
"description": "Total number of event resources across all pages that satisfy query parameters."
},
"items": {
"type": "array",
"minItems": 0,
"maxItems": 100,
"description": "Paginated list of event resources.",
"items": {
"$ref": "#/components/schemas/event"
}
}
}
},
{
"$ref": "#/components/schemas/collection.links"
}
]
},
"event.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "No embedded resources on a event(s) response. Expect an empty object if embedded are requested.",
"type": [
"object",
"null"
]
}
}
},
"events.read": {
"allOf": [
{
"$ref": "#/components/schemas/events"
},
{
"$ref": "#/components/schemas/event.embedded"
}
]
},
"event.read": {
"allOf": [
{
"$ref": "#/components/schemas/event"
},
{
"$ref": "#/components/schemas/event.embedded"
}
]
},
"webhook-endpoint": {
"title": "webhook-endpoint",
"x-tags": [
"Webhooks"
],
"description": "A webhook-endpoint describes the endpoint on your side that will receive events from your Lucca account.\n\nIt must handle HTTPS and support POST requests.\n\nIt should always check the signature of received events in order to increase security.\n\nIt should respond as fast as possible (less than 3s), otherwise the server may stop sending it events.\n\nPlease refer to the [webhooks documentation](/documentation/webhooks/get-started) to learn more about webhook-endpoints.",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "webhook-endpoint"
},
"url": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string",
"minLength": 1
},
"apiVersion": {
"type": "string",
"format": "date"
},
"webhookUrl": {
"type": "string",
"format": "uri",
"description": "URL of the receiving endpoint on your side. MUST use the `https://` schema."
},
"topics": {
"type": "array",
"description": "See complete [list of all topics](/api-reference/2024-11-01/events/event) in the event definition.",
"items": {
"type": "string"
}
},
"businessEstablishments": {
"description": "Restrict events to those belonging to one of the given business-establishments. `null` should be interpreted as \"all business establishments\".",
"type": [
"null",
"array"
],
"uniqueItems": true,
"minItems": 1,
"items": {
"$ref": "#/components/schemas/business-establishment-reference"
}
},
"status": {
"description": "'active': delivery attempts will be executed.\n'suspended': if too many errors are encountered on delivery. Events are kept in history.\n'inactive': events are neither sent nor kept in history.",
"type": "string",
"enum": [
"active",
"suspended",
"inactive"
],
"x-enumDescriptions": {
"active": "Events will be delivered.",
"suspended": "Events are not be delivered but are kept in history.",
"inactive": "Events are neither sent nor kept in history."
},
"default": "inactive"
},
"createdAt": {
"$ref": "#/components/schemas/createdAt"
},
"lastUpdatedAt": {
"$ref": "#/components/schemas/lastUpdatedAt"
},
"links": {
"type": [
"object",
"null"
]
}
},
"example": {
"id": "456789412",
"type": "webhook-endpoint",
"url": "https://example.ilucca.net/lucca-api/webhook-endpoints/93847DF7FDSF6D87SF",
"name": "Test",
"apiVersion": "2024-11-01",
"webhookUrl": "https://i-am-aweso.me/lucca-webhooks/123",
"topics": [
"employee.created",
"employee.updated"
],
"status": "active",
"createdAt": "2023-04-23T09:23:54.001Z",
"lastUpdatedAt": "2023-04-23T09:23:54.001Z",
"links": {}
}
},
"webhook-endpoints": {
"title": "webhook-endpoints",
"description": "A collection of webhook-endpoint objects.",
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "webhook-endpoints"
},
"url": {
"type": "string",
"format": "uri"
},
"totalCount": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0,
"description": "Total number of webhook-endpoint resources across all pages that satisfy query parameters."
},
"items": {
"type": "array",
"minItems": 0,
"maxItems": 100,
"description": "Paginated list of webhook-endpoint resources.",
"items": {
"$ref": "#/components/schemas/webhook-endpoint"
}
}
}
},
{
"$ref": "#/components/schemas/collection.links"
}
]
},
"webhook-endpoint.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "No embedded resources on a webhook-endpoint(s) response. Expect an empty object if embedded are requested.",
"type": [
"object",
"null"
]
}
}
},
"webhook-endpoints.read": {
"allOf": [
{
"$ref": "#/components/schemas/webhook-endpoints"
},
{
"$ref": "#/components/schemas/webhook-endpoint.embedded"
}
]
},
"webhook-endpoint.update": {
"title": "webhook-endpoint",
"x-tags": [
"Webhooks"
],
"description": "A webhook-endpoint describes the endpoint on your side that will receive events from your Lucca account.\n\nIt must handle HTTPS and support POST requests.\n\nIt should always check the signature of received events in order to increase security.\n\nIt should respond as fast as possible (less than 3s), otherwise the server may stop sending it events.\n\nPlease refer to the [webhooks documentation](/documentation/webhooks/get-started) to learn more about webhook-endpoints.",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"apiVersion": {
"type": "string",
"format": "date"
},
"webhookUrl": {
"type": "string",
"format": "uri",
"description": "URL of the receiving endpoint on your side. MUST use the `https://` schema."
},
"topics": {
"type": "array",
"description": "See complete [list of all topics](/api-reference/2024-11-01/events/event) in the event definition.",
"items": {
"type": "string"
}
},
"businessEstablishments": {
"type": [
"null",
"array"
],
"uniqueItems": true,
"minItems": 1,
"items": {
"title": "business-establishment-reference",
"description": "Reference to a [business-establishment](/api-reference/2024-11-01/organization/business-establishment) resource.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
]
}
},
"status": {
"description": "'active': delivery attempts will be executed.\n'suspended': if too many errors are encountered on delivery. Events are kept in history.\n'inactive': events are neither sent nor kept in history.",
"type": "string",
"enum": [
"active",
"suspended",
"inactive"
],
"x-enumDescriptions": {
"active": "Events will be delivered.",
"suspended": "Events are not be delivered but are kept in history.",
"inactive": "Events are neither sent nor kept in history."
},
"default": "inactive"
}
}
},
"webhook-endpoint.create": {
"type": "object",
"required": [
"name",
"webhookUrl",
"apiVersion",
"topics"
],
"allOf": [
{
"$ref": "#/components/schemas/webhook-endpoint.update"
}
]
},
"webhook-endpoint.read": {
"allOf": [
{
"$ref": "#/components/schemas/webhook-endpoint"
},
{
"$ref": "#/components/schemas/webhook-endpoint.embedded"
}
]
},
"event-reference": {
"title": "event-reference",
"description": "Reference to an [(webhook-)event](/api-reference/2024-11-01/events/event) resource.",
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"const": "event",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
}
},
"examples": [
{
"id": "2455623",
"type": "event",
"url": "https://example.ilucca.net/lucca-api/events/2455623"
}
]
},
"webhook-endpoint-reference": {
"title": "webhook-endpoint-reference",
"description": "Reference to a [webhook-endpoint](/api-reference/2024-11-01/webhooks/webhook-endpoint) resource.",
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "webhook-endpoint",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
}
}
},
"webhook-delivery": {
"title": "webhook-delivery",
"x-tags": [
"Webhooks"
],
"description": "A webhook-delivery is the object that represents the job to send an event to a [webhook-endpoint](/api-reference/2024-11-01/webhooks/webhook-endpoint). It will lead to one or more [webhook-delivery-attempt](/api-reference/2024-11-01/webhooks/webhook-delivery-attempt).",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Uniquely identifies the webhook-delivery."
},
"type": {
"type": "string",
"const": "webhook-delivery"
},
"url": {
"type": "string",
"format": "uri"
},
"nextAttemptAt": {
"description": "Timestamp of the next planned webhook-delivery-attempt (UTC).",
"type": "string",
"format": "date-time"
},
"attemptsCount": {
"description": "Number of times this event has been attempted to be delivered.",
"type": "integer",
"format": "int32",
"minimum": 0,
"examples": [
2
]
},
"status": {
"description": "Indicates whether the event has been delivered or not.",
"type": "string",
"enum": [
"delivered",
"undelivered",
"failed"
],
"x-enumDescriptions": {
"delivered": "Webhook-delivery was successful.",
"undelivered": "Webhook-delivery failed but a new\nwebhook-delivery-attempt is scheduled.",
"failed": "Webhook-delivery failed and no new\nwebhook-delivery-attempt will be made."
}
},
"event": {
"$ref": "#/components/schemas/event-reference"
},
"webhookEndpoint": {
"$ref": "#/components/schemas/webhook-endpoint-reference"
},
"links": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"attempts": {
"type": "object",
"properties": {
"href": {
"type": "string",
"format": "uri"
}
}
}
}
}
},
"example": {
"id": "78fa5d8c-3436-49aa-82cc-ab1a64c48ed9",
"type": "webhook-delivery",
"url": "https://example.ilucca.net/lucca-api/webhook-deliveries/78fa5d8c-3436-49aa-82cc-ab1a64c48ed9",
"nextAttemptAt": "2023-08-29T09:12:33.001Z",
"attemptsCount": 2,
"status": "delivered",
"event": {
"id": "2455623",
"type": "event",
"url": "https://example.ilucca.net/lucca-api/events/2455623"
},
"webhookEndpoint": {
"id": "12",
"type": "webhook-endpoint",
"url": "https://example.ilucca.net/lucca-api/webhook-endpoints/12"
},
"links": {
"attempts": {
"href": "https://example.ilucca.net/lucca-api/webhook-delivery-attempts?webhookDelivery.id=78fa5d8c-3436-49aa-82cc-ab1a64c48ed9"
}
}
}
},
"webhook-deliveries": {
"title": "webhook-deliveries",
"description": "A collection of webhook-delivery objects.",
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "webhook-deliveries"
},
"url": {
"type": "string",
"format": "uri"
},
"totalCount": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0,
"description": "Total number of webhook-delivery resources across all pages that satisfy query parameters."
},
"items": {
"type": "array",
"minItems": 0,
"maxItems": 100,
"description": "Paginated list of webhook-delivery resources.",
"items": {
"$ref": "#/components/schemas/webhook-delivery"
}
}
}
},
{
"$ref": "#/components/schemas/collection.links"
}
]
},
"webhook-delivery.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "Embeds the representation of resources related to the webhook-delivery(ies).\n\nOnly returned if requested by the API client: `?include=embedded`.",
"type": [
"object",
"null"
],
"properties": {
"event": {
"description": "Webhook-event(s) that are the payload for these deliveries (cf. `webhookDeliveryAttempt.webhookDelivery.event`).\n\nStructured as a dictionary of [(webhook-)events](/api-reference/2024-11-01/events/event) indexed by their ID.",
"type": [
"object",
"null"
],
"additionalProperties": {
"$ref": "#/components/schemas/event"
}
}
}
}
}
},
"webhook-deliveries.read": {
"allOf": [
{
"$ref": "#/components/schemas/webhook-deliveries"
},
{
"$ref": "#/components/schemas/webhook-delivery.embedded"
}
]
},
"webhook-delivery.update": {
"allOf": [
{
"$ref": "#/components/schemas/webhook-delivery"
},
{
"type": "object",
"properties": {
"id": {
"readOnly": true
},
"type": {
"readOnly": true
},
"url": {
"readOnly": true
},
"nextAttemptAt": {
"readOnly": true
},
"attemptsCount": {
"readOnly": true
},
"status": {
"readOnly": true
},
"event": {
"readOnly": true
},
"links": {
"readOnly": true
}
}
}
]
},
"webhook-delivery.create": {
"type": "object",
"required": [
"webhookEndpoint"
],
"allOf": [
{
"$ref": "#/components/schemas/webhook-delivery.update"
}
]
},
"webhook-delivery.read": {
"allOf": [
{
"$ref": "#/components/schemas/webhook-delivery"
},
{
"$ref": "#/components/schemas/webhook-delivery.embedded"
}
]
},
"webhook-delivery-reference": {
"title": "webhook-delivery-reference",
"description": "Reference to a [webhook-deliver](/api-reference/2024-11-01/webhooks/webhook-delivery) resource.",
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"const": "webhook-delivery",
"enum": [
"webhook-delivery"
],
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
}
}
},
"webhook-delivery-attempt": {
"title": "webhook-delivery-attempt",
"description": "A webhook-delivery-attempt is an attempt to send an [event](/api-reference/2024-11-01/events/event) to a [webhook-endpoint](/api-reference/2024-11-01/webhooks/webhook-endpoint).\n\nFor any [webhook-delivery](/api-reference/2024-11-01/webhooks/webhook-delivery), there may be multiple webhook-delivery-attempts, as the webhook service will retry sending an event if the webhook-endpoint fails to respond successfully.",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "webhook-delivery-attempt"
},
"url": {
"type": "string",
"format": "uri"
},
"signature": {
"type": "string",
"minLength": 1
},
"webhookDelivery": {
"$ref": "#/components/schemas/webhook-delivery-reference"
},
"isSuccessful": {
"type": "boolean"
},
"responseStatusCode": {
"type": "integer",
"minimum": 100,
"maximum": 599
},
"errorResponseBody": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"links": {
"type": [
"object",
"null"
]
}
},
"example": {
"id": "874",
"type": "webhook-delivery-attempt",
"url": "https://example.ilucca.net/lucca-api/webhook-delivery-attempts/874",
"signature": "9087FD897DSF87D67F78SD6F876SD78F6SD7886F78SD6F87SD678F6SD78F6SD786FS876F78SD6F786FYJHXWYCV78C6FV7868S7FDS78",
"webhookDelivery": {
"id": "87",
"type": "webhook-delivery",
"url": "https://example.ilucca.net/lucca-api/webhook-deliveries/87"
},
"isSuccessful": true,
"responseStatusCode": 202,
"errorResponseBody": "",
"createdAt": "2024-04-03T09:23:56.235Z",
"links": {}
}
},
"webhook-delivery-attempts": {
"title": "webhook-delivery-attempts",
"description": "webhook-delivery-attempts",
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "webhook-delivery-attempts"
},
"url": {
"type": "string",
"format": "uri"
},
"totalCount": {
"type": [
"integer",
"null"
],
"format": "int64",
"minimum": 0,
"description": "Total number of webhook-delivery-attempt resources across all pages that satisfy query parameters."
},
"items": {
"type": "array",
"minItems": 0,
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/webhook-delivery-attempt"
}
}
}
},
{
"$ref": "#/components/schemas/collection.links"
}
]
},
"webhook-delivery-attempt.embedded": {
"type": "object",
"properties": {
"embedded": {
"description": "Embeds the representation of resources related to the webhook-delivery-attempt(s).\n\nOnly returned if requested by the API client: `?include=embedded`.",
"type": [
"object",
"null"
],
"properties": {
"webhook-delivery": {
"description": "Webhook-deliveries these were the attempts of (cf. `webhookDeliveryAttempt.webhookDelivery`).\n\nStructured as a dictionary of [webhook-deliveries](/api-reference/2024-11-01/webhooks/webhook-delivery) indexed by their ID.",
"type": [
"object",
"null"
],
"additionalProperties": {
"$ref": "#/components/schemas/webhook-delivery"
}
},
"event": {
"description": "Webhook-event(s) that are the payload for these deliveries (cf. `webhookDeliveryAttempt.webhookDelivery.event`).\n\nStructured as a dictionary of [(webhook-)events](/api-reference/2024-11-01/events/event) indexed by their ID.",
"type": [
"object",
"null"
],
"additionalProperties": {
"$ref": "#/components/schemas/event"
}
}
}
}
}
},
"webhook-delivery-attempts.read": {
"allOf": [
{
"$ref": "#/components/schemas/webhook-delivery-attempts"
},
{
"$ref": "#/components/schemas/webhook-delivery-attempt.embedded"
}
]
},
"webhook-delivery-attempt.read": {
"allOf": [
{
"$ref": "#/components/schemas/webhook-delivery-attempt"
},
{
"$ref": "#/components/schemas/webhook-delivery-attempt.embedded"
}
]
}
},
"responses": {
"400": {
"description": "Bad request. You may:\n - (write requests) make sure the request body conforms with the expected schema.\n - double check all required parameters are set.",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
},
"example": {
"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."
}
}
}
}
},
"401": {
"description": "You are not authenticated. Please refresh your token.",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
},
"example": {
"type": "https://datatracker.ietf.org/doc/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"instance": "https://example.ilucca.net/lucca-api/employees/1573"
}
}
}
},
"403": {
"description": "You do not have the required oAuth scopes.",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
},
"Deprecation": {
"$ref": "#/components/headers/deprecation"
},
"Sunset": {
"$ref": "#/components/headers/sunset"
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
},
"example": {
"type": "https://datatracker.ietf.org/doc/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 403,
"instance": "https://example.ilucca.net/lucca-api/employees/1573"
}
}
}
},
"404": {
"description": "Not Found. Resource may have previously been deleted.",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"instance": "https://example.ilucca.net/lucca-api/employees/1573"
}
}
}
},
"500": {
"description": "Internal server error.",
"headers": {
"Api-Version": {
"$ref": "#/components/headers/api-version"
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/problem"
},
"example": {
"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"
}
}
}
}
},
"examples": {
"file.get.example": {
"value": {
"id": "2face165-5345-4cf3-ab05-5421a6b19df2",
"type": "file",
"url": "https://example.ilucca.net/lucca-api/files/2face165-5345-4cf3-ab05-5421a6b19df2",
"fileName": "pic.jpg",
"contentType": "image/jpg",
"createdAt": "2024-01-15T08:30:00Z",
"links": {},
"embedded": {}
}
},
"legal-entities.get.example": {
"summary": "legal-entities GET example",
"description": "legal-entities GET example",
"value": {
"type": "legal-entities",
"url": "https://example.ilucca.net/lucca-api/legal-entities?limit=25",
"totalCount": 121,
"items": [
{
"id": "123",
"type": "legal-entity",
"url": "https://example.ilucca.net/lucca-api/legal-entities/123",
"legalName": "Lucca S.A.S.",
"remoteId": "LE:83.2938",
"isArchived": false,
"countryCode": "FRA",
"currencyCode": "EUR",
"taxIdentificationNumber": {
"format": "franceSIREN",
"value": "44163769100128"
},
"industryCode": {
"format": "franceAPE",
"value": "7022Z"
},
"createdAt": "2024-01-01T08:34:23.0001Z",
"lastUpdatedAt": "2024-01-01T08:34:23.0001Z",
"lastArchivedAt": null,
"links": {
"businessEstablishments": {
"href": "https://example.ilucca.net/lucca-api/business-establishments?legalEntity.id=123"
}
}
}
],
"embedded": {},
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/legal-entities?page=2qs1dqsd45&limit=25",
"cursor": "2qs1dqsd45"
}
}
}
},
"legal-entity.get.example": {
"summary": "legal-entity GET example",
"description": "legal-entity GET example",
"value": {
"id": "123",
"type": "legal-entity",
"url": "https://example.ilucca.net/lucca-api/legal-entities/123",
"legalName": "Lucca S.A.S.",
"remoteId": "LE:83.2938",
"isArchived": false,
"countryCode": "FRA",
"currencyCode": "EUR",
"taxIdentificationNumber": {
"format": "franceSIREN",
"value": "44163769100128"
},
"industryCode": {
"format": "franceAPE",
"value": "7022Z"
},
"createdAt": "2024-01-01T08:34:23.0001Z",
"lastUpdatedAt": "2024-01-01T08:34:23.0001Z",
"lastArchivedAt": null,
"links": {
"businessEstablishments": {
"href": "https://example.ilucca.net/lucca-api/business-establishments?legalEntity.id=123"
}
},
"embedded": {}
}
},
"business-establishments.get.example": {
"summary": "business-establishments GET example",
"description": "business-establishments GET example",
"value": {
"type": "business-establishments",
"url": "https://example.ilucca.net/lucca-api/business-establishments?limit=25",
"totalCount": 28,
"items": [
{
"id": "5",
"type": "business-establishment",
"url": "https://example.ilucca.net/lucca-api/business-establishments/5",
"name": "Lucca Marseille",
"remoteId": "00004",
"legalEntity": {
"id": "123",
"type": "legal-entity",
"url": "https://example.ilucca.net/lucca-api/legal-entities/123"
},
"taxIdentificationNumber": {
"format": "franceSIRET",
"value": "0000000000000"
},
"address": {
"addressLines": [
"Lucca",
"10 Place de la Joliette",
"Les Docks Atrium 10.2"
],
"postalCode": "13002",
"locality": "Marseille",
"administrativeArea": "Bouches-du-Rhône",
"countryCode": "FRA"
},
"timezoneId": "Europe/Paris",
"isArchived": false,
"lastArchivedAt": null,
"createdAt": "2024-05-23T13:45:26.0001Z",
"lastUpdatedAt": "2024-05-23T13:45:26.0001Z",
"links": {}
}
],
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/business-establishments?page=!sdk87Sdh&limit=25",
"cursor": "!sdk87Sdh"
}
},
"embedded": {
"legal-entity": {
"123": {
"id": "123",
"type": "legal-entity",
"url": "https://example.ilucca.net/lucca-api/legal-entities/123",
"legalName": "Lucca S.A.S.",
"remoteId": "LE:83.2938",
"countryCode": "FRA",
"currencyCode": "EUR",
"taxIdentificationNumber": {
"format": "franceSIREN",
"value": "44163769100128"
},
"industryCode": {
"format": "franceAPE",
"value": "7022Z"
},
"createdAt": "2024-01-01T08:34:23.0001Z",
"lastUpdatedAt": "2024-01-01T08:34:23.0001Z",
"lastArchivedAt": null,
"links": {
"businessEstablishments": {
"href": "https://example.ilucca.net/lucca-api/business-establishments?legalEntity.id=123"
}
}
}
}
}
}
},
"business-establishment.get.example": {
"summary": "business-establishment GET example",
"description": "business-establishment GET example",
"value": {
"id": "5",
"type": "business-establishment",
"url": "https://example.ilucca.net/lucca-api/business-establishments/5",
"name": "Lucca Marseille",
"remoteId": "00004",
"legalEntity": {
"id": "123",
"type": "legal-entity",
"url": "https://example.ilucca.net/lucca-api/legal-entities/123"
},
"taxIdentificationNumber": {
"format": "franceSIRET",
"value": "0000000000000"
},
"address": {
"addressLines": [
"Lucca",
"10 Place de la Joliette",
"Les Docks Atrium 10.2"
],
"postalCode": "13002",
"locality": "Marseille",
"administrativeArea": "Bouches-du-Rhône",
"countryCode": "FRA"
},
"timezoneId": "Europe/Paris",
"isArchived": false,
"lastArchivedAt": null,
"createdAt": "2024-05-23T13:45:26.0001Z",
"lastUpdatedAt": "2024-05-23T13:45:26.0001Z",
"links": {},
"embedded": {
"legal-entity": {
"123": {
"id": "123",
"type": "legal-entity",
"url": "https://example.ilucca.net/lucca-api/legal-entities/123",
"legalName": "Lucca S.A.S.",
"remoteId": "LE:83.2938",
"countryCode": "FRA",
"currencyCode": "EUR",
"taxIdentificationNumber": {
"format": "franceSIREN",
"value": "44163769100128"
},
"industryCode": {
"format": "franceAPE",
"value": "7022Z"
},
"createdAt": "2024-01-01T08:34:23.0001Z",
"lastUpdatedAt": "2024-01-01T08:34:23.0001Z",
"lastArchivedAt": null,
"links": {
"businessEstablishments": {
"href": "https://example.ilucca.net/lucca-api/business-establishments?legalEntity.id=123"
}
}
}
}
}
}
},
"departments.get.example": {
"summary": "departments GET example",
"description": "departments GET example",
"value": {
"type": "departments",
"url": "https://example.ilucca.net/lucca-api/departments?limit=25",
"totalCount": 11,
"items": [
{
"id": "32",
"type": "department",
"url": "https://example.ilucca.net/lucca-api/departments/32",
"name": "Finances",
"description": null,
"remoteId": "FIN",
"isArchived": false,
"parent": null,
"level": 1,
"sortOrder": 2,
"manager": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"owningApplication": null,
"links": {}
}
],
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/departments?page=!sdk87Sdh&limit=25",
"cursor": "!sdk87Sdh"
}
},
"embedded": {}
}
},
"departments.post.example": {
"summary": "department POST example",
"description": "department POST example",
"value": {
"name": "Finances",
"description": null,
"remoteId": "FIN",
"isArchived": false,
"parent": null,
"manager": {
"id": "416"
},
"sortOrder": 2,
"owningApplication": null
}
},
"department.get.example": {
"summary": "department GET example",
"description": "department GET example",
"value": {
"id": "32",
"type": "department",
"url": "https://example.ilucca.net/lucca-api/departments/32",
"name": "Finances",
"description": null,
"remoteId": "FIN",
"isArchived": false,
"parent": null,
"level": 1,
"manager": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"sortOrder": 2,
"owningApplication": null,
"links": {
"activeEmployees": {
"href": "https://example.ilucca.net/lucca-api/employees?applicableJobPosition.department.id=32"
}
},
"embedded": {}
}
},
"department.patch.example": {
"summary": "department PATCH example",
"description": "department PATCH example",
"value": {
"name": "Finances",
"remoteId": "FIN"
}
},
"professions.get.example": {
"summary": "professions GET example",
"description": "professions GET example",
"value": {
"type": "professions",
"url": "https://example.ilucca.net/lucca-api/professions?limit=25",
"totalCount": 29,
"items": [
{
"id": "89",
"type": "profession",
"url": "https://example.ilucca.net/lucca-api/professions/89",
"title": "Developer",
"isArchived": false,
"t9n": {
"title": {
"fr-FR": "Développeur"
}
},
"links": {}
}
],
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/professions?page=!43df&limit=25",
"cursor": "!43df"
}
},
"embedded": {}
}
},
"profession.get.example": {
"summary": "profession GET example",
"description": "profession GET example",
"value": {
"id": "89",
"type": "profession",
"url": "https://example.ilucca.net/lucca-api/professions/89",
"title": "Developer",
"isArchived": false,
"t9n": {
"title": {
"fr-FR": "Développeur"
}
},
"links": {},
"embedded": {}
}
},
"occupation-categories.get.example": {
"summary": "occupation-categories GET example",
"description": "occupation-categories GET example",
"value": {
"type": "occupation-categories",
"url": "https://example.ilucca.net/lucca-api/occupation-categories?limit=25",
"totalCount": 29,
"items": [
{
"id": "45",
"type": "occupation-category",
"url": "https://example.ilucca.net/lucca-api/occupation-categories/45",
"title": "Executive",
"businessEstablishments": [
{
"id": "5",
"type": "business-establishment",
"url": "https://example.ilucca.net/lucca-api/business-establishments/5"
}
],
"t9n": {
"title": {
"fr-FR": "Cadre"
}
},
"links": {}
}
],
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/occupation-categories?page=!43df&limit=25",
"cursor": "!43df"
}
},
"embedded": {}
}
},
"occupation-category.get.example": {
"summary": "occupation-category GET example",
"description": "occupation-category GET example",
"value": {
"id": "45",
"type": "occupation-category",
"url": "https://example.ilucca.net/lucca-api/occupation-categories/45",
"title": "Executive",
"businessEstablishments": [
{
"id": "5",
"type": "business-establishment",
"url": "https://example.ilucca.net/lucca-api/business-establishments/5"
}
],
"t9n": {
"title": {
"fr-FR": "Cadre"
}
},
"links": {},
"embedded": {}
}
},
"job-qualifications.get.example": {
"summary": "job-qualifications GET example",
"description": "job-qualifications GET example",
"value": {
"type": "job-qualifications",
"url": "https://example.ilucca.net/lucca-api/job-qualifications?limit=25",
"totalCount": 943,
"items": [
{
"id": "982",
"type": "job-qualification",
"url": "https://example.ilucca.net/lucca-api/job-qualifications/982",
"title": "Lead Developer",
"profession": {
"id": "89",
"type": "profession",
"url": "https://example.ilucca.net/lucca-api/professions/89"
},
"rank": 2,
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {}
}
],
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/job-qualifications?page=!32443df&limit=25",
"cursor": "!32443df"
}
},
"embedded": {}
}
},
"job-qualification.get.example": {
"summary": "job-qualification GET example",
"description": "job-qualification GET example",
"value": {
"id": "982",
"type": "job-qualification",
"url": "https://example.ilucca.net/lucca-api/job-qualifications/982",
"title": "Lead Developer",
"profession": {
"id": "89",
"type": "profession",
"url": "https://example.ilucca.net/lucca-api/professions/89"
},
"rank": 2,
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {},
"embedded": {}
}
},
"employees.get.example": {
"summary": "employees GET example",
"description": "employees GET example",
"value": {
"type": "employees",
"url": "https://example.ilucca.net/lucca-api/employees?limit=25",
"totalCount": 647,
"items": [
{
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416",
"remoteId": "00002345",
"portrait": {
"id": "2face165-5345-4cf3-ab05-5421a6b19df2",
"type": "portrait",
"url": "https://example.ilucca.net/lucca-api/portraits/2face165-5345-4cf3-ab05-5421a6b19df2"
},
"givenName": "Edward",
"familyName": "Atkinson",
"employeeNumber": "E000124",
"status": "active",
"email": "eatkinson@acme.corp",
"birthDay": {
"day": 22,
"month": 12
},
"phoneNumber": "+33145784512",
"applicableEmployment": {
"id": "154",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/154"
},
"applicableJobPosition": {
"id": "74",
"type": "job-position",
"url": "https://example.ilucca.net/lucca-api/job-positions/74"
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"portrait": {
"href": "https://example.ilucca.net/lucca-api/files/2face165-5345-4cf3-ab05-5421a6b19df2?token=eyXXXXXXXX"
},
"employments": {
"href": "https://example.ilucca.net/lucca-api/employments?employee.id=416"
},
"jobPositions": {
"href": "https://example.ilucca.net/lucca-api/job-positions?employment.employee.id=416"
},
"personalRecord": {
"href": "https://example.ilucca.net/lucca-api/employee-personal-records?employee.id=416"
},
"files": {
"2face165-5345-4cf3-ab05-5421a6b19df2": {
"href": "https://example.ilucca.net/lucca-api/files/2face165-5345-4cf3-ab05-5421a6b19df2?token=eyXXXXXXXX&disposition=attachment",
"expiresAt": "2026-10-21T15:01:38.7634288Z",
"token": "eyXXXXXXXX"
}
}
}
}
],
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/employees?page=!sdk87Sdh&limit=25",
"cursor": "!sdk87Sdh"
}
},
"embedded": {
"employment": {
"4561": {
"id": "4561",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/4561",
"remoteId": "EMPLOYMENT#4512-ac",
"employee": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"legalEntity": {
"id": "123",
"type": "legal-entity",
"url": "https://example.ilucca.net/lucca-api/legal-entities/123"
},
"status": "active",
"start": {
"date": "2024-01-01"
},
"end": null,
"document": {
"id": "9154c6a2-6105-4d5d-bfb6-5fd2d54037b3",
"type": "file",
"url": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3"
},
"template": {
"id": "4",
"type": "employment-template",
"url": "https://example.ilucca.net/lucca-api/employment-templates/4"
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"document": {
"href": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3?token=eyXXXXXXXX&disposition=json"
},
"jobPositions": {
"href": "https://example.ilucca.net/lucca-api/job-positions?employment.id=4561"
},
"probationaryPeriods": {
"href": "https://example.ilucca.net/lucca-api/probationary-periods?employment.id=4561"
},
"files": {
"9154c6a2-6105-4d5d-bfb6-5fd2d54037b3": {
"href": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3?token=eyXXXXXXXX&disposition=attachment",
"expiresAt": "2026-10-21T15:01:38.7634288Z",
"token": "eyXXXXXXXX"
}
}
}
}
},
"job-position": {
"74": {
"id": "74",
"type": "job-position",
"url": "https://example.ilucca.net/lucca-api/job-positions/74",
"remoteId": null,
"employment": {
"id": "28",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/28"
},
"employee": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"status": "active",
"startsOn": "2024-01-01",
"endsOn": null,
"businessEstablishment": {
"id": "5",
"type": "business-establishment",
"url": "https://example.ilucca.net/lucca-api/business-establishments/5"
},
"jobTitle": "Developer",
"jobQualification": {
"id": "982",
"type": "job-qualification",
"url": "https://example.ilucca.net/lucca-api/job-qualifications/982"
},
"manager": {
"id": "541",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/541"
},
"occupationCategory": {
"id": "12",
"type": "occupation-category",
"url": "https://example.ilucca.net/lucca-api/occupation-categories/12"
},
"workingTimeArrangement": {
"id": "23",
"type": "working-time-arrangement",
"url": "https://example.ilucca.net/lucca-api/working-time-arrangements/23"
},
"department": {
"id": "32",
"type": "department",
"url": "https://example.ilucca.net/lucca-api/departments/32"
},
"document": null,
"notes": null,
"updatedAttributes": [
"jobTitle",
"jobQualification"
],
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {}
}
}
}
}
},
"employees.post.example": {
"summary": "employee POST example",
"description": "employee POST example",
"value": {
"remoteId": "eatkinson",
"portrait": {
"id": "2face165-5345-4cf3-ab05-5421a6b19df2"
},
"givenName": "Edward",
"familyName": "Atkinson",
"employeeNumber": "E000124",
"email": "eatkinson@acme.corp",
"phoneNumber": "+33145784512",
"firstEmployment": {
"remoteId": "EMPLOYMENT#4512-ac",
"legalEntity": {
"id": "123"
},
"start": {
"date": "2024-01-01"
},
"end": null,
"document": {
"id": "9154c6a2-6105-4d5d-bfb6-5fd2d54037b3"
},
"template": {
"id": "4"
},
"firstJobPosition": {
"remoteId": null,
"businessEstablishment": {
"id": "5"
},
"jobTitle": "Developer",
"jobQualification": {
"id": "982"
},
"manager": {
"id": "541"
},
"occupationCategory": {
"id": "12"
},
"workingTimeArrangement": {
"id": "23"
},
"department": {
"id": "32"
},
"document": null
}
}
}
},
"employee.get.example": {
"summary": "employee GET example",
"description": "employee GET example",
"value": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416",
"remoteId": "00002345",
"portrait": {
"id": "2face165-5345-4cf3-ab05-5421a6b19df2",
"type": "portrait",
"url": "https://example.ilucca.net/lucca-api/portraits/2face165-5345-4cf3-ab05-5421a6b19df2"
},
"givenName": "Edward",
"familyName": "Atkinson",
"employeeNumber": "E000124",
"status": "active",
"email": "eatkinson@acme.corp",
"birthDay": {
"day": 22,
"month": 12
},
"phoneNumber": "+33145784512",
"applicableEmployment": {
"id": "154",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/154"
},
"applicableJobPosition": {
"id": "74",
"type": "job-position",
"url": "https://example.ilucca.net/lucca-api/job-positions/74"
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"portrait": {
"href": "https://example.ilucca.net/lucca-api/files/2face165-5345-4cf3-ab05-5421a6b19df2?token=eyXXXXXXXX"
},
"employments": {
"href": "https://example.ilucca.net/lucca-api/employments?employee.id=416"
},
"jobPositions": {
"href": "https://example.ilucca.net/lucca-api/job-positions?employment.employee.id=416"
},
"personalRecord": {
"href": "https://example.ilucca.net/lucca-api/employee-personal-records?employee.id=416"
},
"files": {
"2face165-5345-4cf3-ab05-5421a6b19df2": {
"href": "https://example.ilucca.net/lucca-api/files/2face165-5345-4cf3-ab05-5421a6b19df2?token=eyXXXXXXXX&disposition=attachment",
"expiresAt": "2026-10-21T15:01:38.7634288Z",
"token": "eyXXXXXXXX"
}
}
},
"embedded": {
"employment": {
"4561": {
"id": "4561",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/4561",
"remoteId": "EMPLOYMENT#4512-ac",
"employee": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"legalEntity": {
"id": "123",
"type": "legal-entity",
"url": "https://example.ilucca.net/lucca-api/legal-entities/123"
},
"status": "active",
"start": {
"date": "2024-01-01"
},
"end": null,
"document": {
"id": "9154c6a2-6105-4d5d-bfb6-5fd2d54037b3",
"type": "file",
"url": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3"
},
"template": {
"id": "4",
"type": "employment-template",
"url": "https://example.ilucca.net/lucca-api/employment-templates/4"
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"document": {
"href": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3?token=eyXXXXXXXX&disposition=json"
},
"jobPositions": {
"href": "https://example.ilucca.net/lucca-api/job-positions?employment.id=4561"
},
"probationaryPeriods": {
"href": "https://example.ilucca.net/lucca-api/probationary-periods?employment.id=4561"
},
"files": {
"9154c6a2-6105-4d5d-bfb6-5fd2d54037b3": {
"href": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3?token=eyXXXXXXXX&disposition=attachment",
"expiresAt": "2026-10-21T15:01:38.7634288Z",
"token": "eyXXXXXXXX"
}
}
}
}
},
"job-position": {
"74": {
"id": "74",
"type": "job-position",
"url": "https://example.ilucca.net/lucca-api/job-positions/74",
"remoteId": null,
"employment": {
"id": "28",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/28"
},
"employee": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"status": "active",
"startsOn": "2024-01-01",
"endsOn": null,
"businessEstablishment": {
"id": "5",
"type": "business-establishment",
"url": "https://example.ilucca.net/lucca-api/business-establishments/5"
},
"jobTitle": "Developer",
"jobQualification": {
"id": "982",
"type": "job-qualification",
"url": "https://example.ilucca.net/lucca-api/job-qualifications/982"
},
"manager": {
"id": "541",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/541"
},
"occupationCategory": {
"id": "12",
"type": "occupation-category",
"url": "https://example.ilucca.net/lucca-api/occupation-categories/12"
},
"workingTimeArrangement": {
"id": "23",
"type": "working-time-arrangement",
"url": "https://example.ilucca.net/lucca-api/working-time-arrangements/23"
},
"department": {
"id": "32",
"type": "department",
"url": "https://example.ilucca.net/lucca-api/departments/32"
},
"document": null,
"notes": null,
"updatedAttributes": [
"jobTitle",
"jobQualification"
],
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {}
}
}
}
}
},
"employee.patch.example": {
"summary": "employee PATCH example",
"description": "employee PATCH example",
"value": {
"remoteId": "00002345",
"portrait": {
"id": "2face165-5345-4cf3-ab05-5421a6b19df2"
},
"givenName": "Edward",
"familyName": "Atkinson",
"employeeNumber": "E000124",
"email": "eatkinson@acme.corp",
"phoneNumber": "+33145784512"
}
},
"employee-attribute-definitions.get.example": {
"summary": "GET employee-attribute-definitions example",
"description": "GET employee-attribute-definitions example",
"value": {
"type": "employee-attribute-definitions",
"url": "https://example.ilucca.net/lucca-api/employee-attribute-definitions?limit=25",
"totalCount": 345,
"items": [
{
"id": "e_tShirtSize",
"type": "employee-attribute-definition",
"url": "https://example.ilucca.net/lucca-api/employee-attribute-definitions/e_tShirtSize",
"name": "T-shirt size",
"multipleValueHandling": null,
"schema": {
"$id": "/lucca-api/schemas/taxonomy-label-reference",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "taxonomy-label-reference",
"type": [
"object",
"null"
],
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "taxonomy-label",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
}
}
},
"taxonomy": {
"id": "45",
"type": "taxonomy",
"url": "https://example.ilucca.net/lucca-api/taxonomies/45"
},
"t9n": {
"name": {
"fr-FR": "Taille de t-shirt"
}
},
"targetType": "employee",
"category": "extension",
"isValueReadOnly": false,
"links": {}
}
]
}
},
"employee-attribute-definition.get.example": {
"summary": "employee-attribute-definition GET example",
"description": "employee-attribute-definition GET example",
"value": {
"id": "e_tShirtSize",
"type": "employee-attribute-definition",
"url": "https://example.ilucca.net/lucca-api/employee-attribute-definitions/e_tShirtSize",
"name": "T-shirt size",
"multipleValueHandling": null,
"schema": {
"$id": "/lucca-api/schemas/taxonomy-label-reference",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "taxonomy-label-reference",
"type": [
"object",
"null"
],
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "taxonomy-label",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
}
}
},
"taxonomy": {
"id": "45",
"type": "taxonomy",
"url": "https://example.ilucca.net/lucca-api/taxonomies/45"
},
"t9n": {
"name": {
"fr-FR": "Taille de t-shirt"
}
},
"targetType": "employee",
"category": "extension",
"isValueReadOnly": false,
"links": {}
}
},
"employee-attribute-definition.patch.example": {
"summary": "employee-attribute-definition PATCH example",
"description": "employee-attribute-definition PATCH example",
"value": {
"isArchived": true
}
},
"employee-attributes.get.example": {
"summary": "employee-attributes GET example",
"description": "employee-attributes GET example",
"value": {
"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": {}
},
{
"id": "34881",
"type": "employee-attribute",
"url": "https://example.ilucca.net/lucca-api/employee-attributes/34881",
"definition": {
"id": "e_idDocument",
"type": "employee-attribute-definition",
"url": "https://example.ilucca.net/lucca-api/employee-attribute-definitions/e_idDocument"
},
"employee": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"applicability": null,
"value": {
"id": "9154c6a2-6105-4d5d-bfb6-5fd2d54037b3",
"type": "file",
"url": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3"
},
"createdAt": "2027-03-01T09:43:52.432Z",
"lastUpdatedAt": "2027-03-01T09:43:52.432Z",
"links": {
"files": {
"9154c6a2-6105-4d5d-bfb6-5fd2d54037b3": {
"href": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3?token=eyXXXXXXXX&disposition=attachment",
"expiresAt": "2027-03-01T10:43:52.432Z",
"token": "eyXXXXXXXX"
}
}
}
}
],
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/employee-attributes?limit=10&page=!4sKv",
"cursor": "!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": {}
}
}
},
"employee-attributes.post.example": {
"summary": "Create an extension attribute value",
"description": "Creating a single-valued extension attribute whose schema is a taxonomy-label-reference.\nA reference value carries only its `id` on write — `type` and `url` are read-only.",
"value": {
"definition": {
"id": "e_tShirtSize"
},
"employee": {
"id": "416"
},
"value": {
"id": "545"
}
}
},
"employee-attributes.post.composite.example": {
"summary": "Create one item of a multi-valued composite attribute",
"description": "For a multi-valued definition such as `e_children`, each POST creates a single item.\nThe `value` is one object matching the definition schema — not an array. Repeat the call to add more items.\nIts property names are the keys of the definition `schema.properties`.",
"value": {
"definition": {
"id": "e_children"
},
"employee": {
"id": "416"
},
"value": {
"e_childGivenName": "Alice",
"e_childFamilyName": "Doe",
"e_childBirthDate": "2015-06-12T00:00:00"
}
}
},
"employee-attribute.get.example": {
"summary": "employee-attribute GET example",
"description": "employee-attribute GET example",
"value": {
"id": "34879",
"type": "employee-attribute",
"url": "https://example.ilucca.net/lucca-api/employee-attribute/34879",
"definition": {
"id": "employee.givenName",
"type": "employee-attribute-definition",
"url": "https://example.ilucca.net/lucca-api/employee-attribute-definitions/employee.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": {},
"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": {}
}
}
},
"employee-attribute.patch.example": {
"summary": "employee-attribute PATCH example",
"description": "employee-attribute PATCH example",
"value": {
"value": "Jane"
}
},
"portrait.get.example": {
"summary": "portrait GET example",
"description": "portrait GET example",
"value": {
"id": "2face165-5345-4cf3-ab05-5421a6b19df2",
"type": "portrait",
"url": "https://example.ilucca.net/lucca-api/portraits/2face165-5345-4cf3-ab05-5421a6b19df2",
"employee": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"fileName": "jdoe-800.jpeg",
"contentType": "image/jpeg",
"links": {},
"embedded": {}
}
},
"employee-personal-records.get.example": {
"summary": "employee-personal-records GET example",
"description": "employee-personal-records GET example",
"value": {
"type": "employee-personal-records",
"url": "https://example.ilucca.net/lucca-api/employee-personal-records?page=qsdkuh&limit=25",
"items": [
{
"id": "897",
"type": "employee-personal-record",
"url": "https://example.ilucca.net/lucca-api/employee-personal-records/897",
"employee": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"title": "mister",
"legalGender": "male",
"maritalStatus": "single",
"birthDate": "1989-12-21",
"insuranceNumber": {
"format": "frenchSSN",
"value": "1760774865895 37"
},
"nationalitiesCountryCodes": [
"FRA"
],
"bankAccount": {
"format": "iban",
"bankName": "BNP Paribas",
"accountIdentifier": "FR7630006000011234567890189",
"bankIdentifier": null
},
"phoneNumber": "+33456789634",
"email": "jdoe13@gmail.com",
"links": {}
}
],
"totalCount": 203,
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/employee-personal-records?page=!sdk87Sdh&limit=25",
"cursor": "!sdk87Sdh"
}
},
"embedded": {
"employee": {
"416": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416",
"remoteId": "00002345",
"portrait": {
"id": "2face165-5345-4cf3-ab05-5421a6b19df2",
"type": "portrait",
"url": "https://example.ilucca.net/lucca-api/portraits/2face165-5345-4cf3-ab05-5421a6b19df2"
},
"givenName": "Edward",
"familyName": "Atkinson",
"employeeNumber": "E000124",
"status": "active",
"email": "eatkinson@acme.corp",
"birthDay": {
"day": 22,
"month": 12
},
"phoneNumber": "+33145784512",
"applicableEmployment": {
"id": "154",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/154"
},
"applicableJobPosition": {
"id": "74",
"type": "job-position",
"url": "https://example.ilucca.net/lucca-api/job-positions/74"
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"portrait": {
"href": "https://example.ilucca.net/lucca-api/files/2face165-5345-4cf3-ab05-5421a6b19df2?token=eyXXXXXXXX"
},
"employments": {
"href": "https://example.ilucca.net/lucca-api/employments?employee.id=416"
},
"jobPositions": {
"href": "https://example.ilucca.net/lucca-api/job-positions?employment.employee.id=416"
},
"personalRecord": {
"href": "https://example.ilucca.net/lucca-api/employee-personal-records?employee.id=416"
},
"files": {
"2face165-5345-4cf3-ab05-5421a6b19df2": {
"href": "https://example.ilucca.net/lucca-api/files/2face165-5345-4cf3-ab05-5421a6b19df2?token=eyXXXXXXXX&disposition=attachment",
"expiresAt": "2026-10-21T15:01:38.7634288Z",
"token": "eyXXXXXXXX"
}
}
}
}
}
}
}
},
"employee-personal-record.get.example": {
"summary": "employee-personal-record GET example",
"description": "employee-personal-record GET example",
"value": {
"id": "897",
"type": "employee-personal-record",
"url": "https://example.ilucca.net/lucca-api/employee-personal-records/897",
"employee": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"title": "mister",
"legalGender": "male",
"maritalStatus": "single",
"birthDate": "1989-12-21",
"insuranceNumber": {
"format": "frenchSSN",
"value": "1760774865895 37"
},
"nationalitiesCountryCodes": [
"FRA"
],
"bankAccount": {
"format": "iban",
"bankName": "BNP Paribas",
"accountIdentifier": "FR7630006000011234567890189",
"bankIdentifier": null
},
"phoneNumber": "+33456789634",
"email": "jdoe13@gmail.com",
"links": {},
"embedded": {
"employee": {
"416": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416",
"remoteId": "00002345",
"portrait": {
"id": "2face165-5345-4cf3-ab05-5421a6b19df2",
"type": "portrait",
"url": "https://example.ilucca.net/lucca-api/portraits/2face165-5345-4cf3-ab05-5421a6b19df2"
},
"givenName": "Edward",
"familyName": "Atkinson",
"employeeNumber": "E000124",
"status": "active",
"email": "eatkinson@acme.corp",
"birthDay": {
"day": 22,
"month": 12
},
"phoneNumber": "+33145784512",
"applicableEmployment": {
"id": "154",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/154"
},
"applicableJobPosition": {
"id": "74",
"type": "job-position",
"url": "https://example.ilucca.net/lucca-api/job-positions/74"
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"portrait": {
"href": "https://example.ilucca.net/lucca-api/files/2face165-5345-4cf3-ab05-5421a6b19df2?token=eyXXXXXXXX"
},
"employments": {
"href": "https://example.ilucca.net/lucca-api/employments?employee.id=416"
},
"jobPositions": {
"href": "https://example.ilucca.net/lucca-api/job-positions?employment.employee.id=416"
},
"personalRecord": {
"href": "https://example.ilucca.net/lucca-api/employee-personal-records?employee.id=416"
},
"files": {
"2face165-5345-4cf3-ab05-5421a6b19df2": {
"href": "https://example.ilucca.net/lucca-api/files/2face165-5345-4cf3-ab05-5421a6b19df2?token=eyXXXXXXXX&disposition=attachment",
"expiresAt": "2026-10-21T15:01:38.7634288Z",
"token": "eyXXXXXXXX"
}
}
}
}
}
}
}
},
"employments.get.examples": {
"summary": "employments GET example",
"description": "employments GET example",
"value": {
"type": "employments",
"url": "https://example.ilucca.net/lucca-api/employments?limit=25",
"totalCount": 483,
"items": [
{
"id": "4561",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/4561",
"remoteId": "JOB#4512-ac",
"employee": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"legalEntity": {
"id": "123",
"type": "legal-entity",
"url": "https://example.ilucca.net/lucca-api/legal-entities/123"
},
"status": "active",
"start": {
"date": "2024-01-01"
},
"end": null,
"document": {
"id": "9154c6a2-6105-4d5d-bfb6-5fd2d54037b3",
"type": "file",
"url": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3"
},
"template": {
"id": "4",
"type": "employment-template",
"url": "https://example.ilucca.net/lucca-api/employment-templates/4"
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"document": {
"href": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3?token=eyXXXXXXXX&disposition=json"
},
"jobPositions": {
"href": "https://example.ilucca.net/lucca-api/job-positions?employment.id=4561"
},
"probationaryPeriods": {
"href": "https://example.ilucca.net/lucca-api/probationary-periods?employment.id=4561"
},
"files": {
"9154c6a2-6105-4d5d-bfb6-5fd2d54037b3": {
"href": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3?token=eyXXXXXXXX&disposition=attachment",
"expiresAt": "2026-10-21T15:01:38.7634288Z",
"token": "eyXXXXXXXX"
}
}
}
}
],
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/employments?page=!sdk87Sdh&limit=25",
"cursor": "!sdk87Sdh"
}
},
"embedded": {
"employee": {
"416": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416",
"remoteId": "00002345",
"portrait": {
"id": "2face165-5345-4cf3-ab05-5421a6b19df2",
"type": "portrait",
"url": "https://example.ilucca.net/lucca-api/portraits/2face165-5345-4cf3-ab05-5421a6b19df2"
},
"givenName": "Edward",
"familyName": "Atkinson",
"employeeNumber": "E000124",
"status": "active",
"email": "eatkinson@acme.corp",
"birthDay": {
"day": 22,
"month": 12
},
"phoneNumber": "+33145784512",
"applicableEmployment": {
"id": "154",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/154"
},
"applicableJobPosition": {
"id": "74",
"type": "job-position",
"url": "https://example.ilucca.net/lucca-api/job-positions/74"
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"portrait": {
"href": "https://example.ilucca.net/lucca-api/files/2face165-5345-4cf3-ab05-5421a6b19df2?token=eyXXXXXXXX"
},
"employments": {
"href": "https://example.ilucca.net/lucca-api/employments?employee.id=416"
},
"jobPositions": {
"href": "https://example.ilucca.net/lucca-api/job-positions?employment.employee.id=416"
},
"personalRecord": {
"href": "https://example.ilucca.net/lucca-api/employee-personal-records?employee.id="
},
"files": {
"2face165-5345-4cf3-ab05-5421a6b19df2": {
"href": "https://example.ilucca.net/lucca-api/files/2face165-5345-4cf3-ab05-5421a6b19df2?token=eyXXXXXXXX&disposition=attachment",
"expiresAt": "2026-10-21T15:01:38.7634288Z",
"token": "eyXXXXXXXX"
}
}
}
}
}
}
}
},
"employments.post.example": {
"summary": "employment POST example",
"description": "employment POST example",
"value": {
"remoteId": "EMPLOYMENT#4512-ac",
"employee": {
"id": "416"
},
"legalEntity": {
"id": "123"
},
"start": {
"date": "2024-01-01"
},
"end": null,
"document": {
"id": "9154c6a2-6105-4d5d-bfb6-5fd2d54037b3"
},
"template": {
"id": "4"
},
"firstJobPosition": {
"remoteId": null,
"businessEstablishment": {
"id": "5"
},
"jobTitle": "Developer",
"jobQualification": {
"id": "982"
},
"manager": {
"id": "541"
},
"occupationCategory": {
"id": "12"
},
"workingTimeArrangement": {
"id": "23"
},
"department": {
"id": "32"
},
"document": null
}
}
},
"employment.get.example": {
"summary": "employment GET example",
"description": "employment GET example",
"value": {
"id": "4561",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/4561",
"remoteId": "EMPLOYMENT#4512-ac",
"employee": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"legalEntity": {
"id": "123",
"type": "legal-entity",
"url": "https://example.ilucca.net/lucca-api/legal-entities/123"
},
"status": "active",
"start": {
"date": "2024-01-01"
},
"end": null,
"document": {
"id": "9154c6a2-6105-4d5d-bfb6-5fd2d54037b3",
"type": "file",
"url": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3"
},
"template": {
"id": "4",
"type": "employment-template",
"url": "https://example.ilucca.net/lucca-api/employment-templates/4"
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"document": {
"href": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3?token=eyXXXXXXXX&disposition=json"
},
"jobPositions": {
"href": "https://example.ilucca.net/lucca-api/job-positions?employment.id=4561"
},
"probationaryPeriods": {
"href": "https://example.ilucca.net/lucca-api/probationary-periods?employment.id=4561"
},
"files": {
"9154c6a2-6105-4d5d-bfb6-5fd2d54037b3": {
"href": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3?token=eyXXXXXXXX&disposition=attachment",
"expiresAt": "2026-10-21T15:01:38.7634288Z",
"token": "eyXXXXXXXX"
}
}
},
"embedded": {
"employee": {
"416": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416",
"remoteId": "00002345",
"portrait": {
"id": "2face165-5345-4cf3-ab05-5421a6b19df2",
"type": "portrait",
"url": "https://example.ilucca.net/lucca-api/portraits/2face165-5345-4cf3-ab05-5421a6b19df2"
},
"givenName": "Edward",
"familyName": "Atkinson",
"employeeNumber": "E000124",
"status": "active",
"email": "eatkinson@acme.corp",
"birthDay": {
"day": 22,
"month": 12
},
"phoneNumber": "+33145784512",
"applicableEmployment": {
"id": "154",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/154"
},
"applicableJobPosition": {
"id": "74",
"type": "job-position",
"url": "https://example.ilucca.net/lucca-api/job-positions/74"
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"portrait": {
"href": "https://example.ilucca.net/lucca-api/files/2face165-5345-4cf3-ab05-5421a6b19df2?token=eyXXXXXXXX"
},
"employments": {
"href": "https://example.ilucca.net/lucca-api/employments?employee.id=416"
},
"jobPositions": {
"href": "https://example.ilucca.net/lucca-api/job-positions?employment.employee.id=416"
},
"personalRecord": {
"href": "https://example.ilucca.net/lucca-api/employee-personal-records?employee.id="
},
"files": {
"2face165-5345-4cf3-ab05-5421a6b19df2": {
"href": "https://example.ilucca.net/lucca-api/files/2face165-5345-4cf3-ab05-5421a6b19df2?token=eyXXXXXXXX&disposition=attachment",
"expiresAt": "2026-10-21T15:01:38.7634288Z",
"token": "eyXXXXXXXX"
}
}
}
}
}
}
}
},
"employment.patch.example": {
"summary": "employment PATCH example",
"description": "employment PATCH example",
"value": {
"remoteId": "EMPLOYMENT#4512-ac",
"start": {
"date": "2024-01-01"
},
"end": null,
"document": {
"id": "9154c6a2-6105-4d5d-bfb6-5fd2d54037b3"
},
"template": {
"id": "4"
}
}
},
"employment-templates.get.example": {
"summary": "employment-templates GET example",
"description": "employment-templates GET example",
"value": {
"type": "employment-templates",
"url": "https://example.ilucca.net/lucca-api/employment-templates?limit=25",
"totalCount": 27,
"items": [
{
"id": "12",
"type": "employment-template",
"url": "https://example.ilucca.net/lucca-api/employment-templates/12",
"title": "Internship",
"legalEntities": [
{
"id": "123",
"type": "legal-entity",
"url": "https://example.ilucca.net/lucca-api/legal-entities/123"
}
],
"term": "fixed",
"audience": "student",
"t9n": {
"title": {
"fr-FR": "Convention de stage"
}
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"extensionDefinitions": {
"href": "https://example.ilucca.net/lucca-api/employee-attribute-definitions?category=extension"
}
}
}
],
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/employment-templates?page=!sdk87Sdh&limit=25",
"cursor": "!sdk87Sdh"
}
},
"embedded": {}
}
},
"employment-template.get.example": {
"summary": "employment-template GET example",
"description": "employment-template GET example",
"value": {
"id": "12",
"type": "employment-template",
"url": "https://example.ilucca.net/lucca-api/employment-templates/12",
"title": "Internship",
"legalEntities": [
{
"id": "123",
"type": "legal-entity",
"url": "https://example.ilucca.net/lucca-api/legal-entities/123"
}
],
"term": "fixed",
"audience": "student",
"t9n": {
"title": {
"fr-FR": "Convention de stage"
}
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"extensionDefinitions": {
"href": "https://example.ilucca.net/lucca-api/employee-attribute-definitions?category=extension"
}
},
"embedded": {}
}
},
"job-positions.get.example": {
"summary": "job-positions GET example",
"description": "job-positions GET example",
"value": {
"type": "job-positions",
"url": "https://example.ilucca.net/lucca-api/job-positions?limit=25",
"totalCount": 872,
"items": [
{
"id": "74",
"type": "job-position",
"url": "https://example.ilucca.net/lucca-api/job-positions/74",
"remoteId": null,
"employment": {
"id": "28",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/28"
},
"employee": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"status": "active",
"startsOn": "2024-01-01",
"endsOn": null,
"businessEstablishment": {
"id": "5",
"type": "business-establishment",
"url": "https://example.ilucca.net/lucca-api/business-establishments/5"
},
"jobTitle": "Developer",
"jobQualification": {
"id": "982",
"type": "job-qualification",
"url": "https://example.ilucca.net/lucca-api/job-qualifications/982"
},
"manager": {
"id": "541",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/541"
},
"occupationCategory": {
"id": "12",
"type": "occupation-category",
"url": "https://example.ilucca.net/lucca-api/occupation-categories/12"
},
"workingTimeArrangement": {
"id": "23",
"type": "working-time-arrangement",
"url": "https://example.ilucca.net/lucca-api/working-time-arrangements/23"
},
"department": {
"id": "32",
"type": "department",
"url": "https://example.ilucca.net/lucca-api/departments/32"
},
"document": {
"id": "c3b1f0de-7a42-4f8e-9d61-2b5e8a0f4c17",
"type": "file",
"url": "https://example.ilucca.net/lucca-api/files/c3b1f0de-7a42-4f8e-9d61-2b5e8a0f4c17"
},
"notes": null,
"t9n": {
"jobTitle": {
"fr-FR": "Développeur"
}
},
"updatedAttributes": [
"jobTitle",
"jobQualification"
],
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"document": {
"href": "https://example.ilucca.net/lucca-api/files/c3b1f0de-7a42-4f8e-9d61-2b5e8a0f4c17?token=eyXXXXXXXX&disposition=json"
},
"files": {
"c3b1f0de-7a42-4f8e-9d61-2b5e8a0f4c17": {
"href": "https://example.ilucca.net/lucca-api/files/c3b1f0de-7a42-4f8e-9d61-2b5e8a0f4c17?token=eyXXXXXXXX&disposition=attachment",
"expiresAt": "2026-10-21T15:01:38.7634288Z",
"token": "eyXXXXXXXX"
}
}
}
}
],
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/job-positions?page=!sdk87Sdh&limit=25",
"cursor": "!sdk87Sdh"
}
},
"embedded": {
"department": {
"32": {
"id": "32",
"type": "department",
"url": "https://example.ilucca.net/lucca-api/departments/32",
"name": "Finances",
"remoteId": "FIN",
"isArchived": false,
"parent": null,
"level": 1,
"manager": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"owningApplication": null,
"links": {}
}
},
"job-qualification": {
"982": {
"id": "982",
"type": "job-qualification",
"url": "https://example.ilucca.net/lucca-api/job-qualifications/982",
"title": "Lead Developer",
"profession": {
"id": "89",
"type": "profession",
"url": "https://example.ilucca.net/lucca-api/professions/89"
},
"rank": 2,
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {}
}
},
"employee": {
"416": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416",
"remoteId": "00002345",
"portrait": {
"id": "2face165-5345-4cf3-ab05-5421a6b19df2",
"type": "portrait",
"url": "https://example.ilucca.net/lucca-api/portraits/2face165-5345-4cf3-ab05-5421a6b19df2"
},
"givenName": "Edward",
"familyName": "Atkinson",
"employeeNumber": "E000124",
"status": "active",
"email": "eatkinson@acme.corp",
"birthDay": {
"day": 22,
"month": 12
},
"phoneNumber": "+33145784512",
"applicableEmployment": {
"id": "154",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/154"
},
"applicableJobPosition": {
"id": "74",
"type": "job-position",
"url": "https://example.ilucca.net/lucca-api/job-positions/74"
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"portrait": {
"href": "https://example.ilucca.net/lucca-api/files/2face165-5345-4cf3-ab05-5421a6b19df2?token=eyXXXXXXXX"
},
"employments": {
"href": "https://example.ilucca.net/lucca-api/employments?employee.id=416"
},
"jobPositions": {
"href": "https://example.ilucca.net/lucca-api/job-positions?employment.employee.id=416"
},
"personalRecord": {
"href": "https://example.ilucca.net/lucca-api/employee-personal-records?employee.id=416"
},
"files": {
"2face165-5345-4cf3-ab05-5421a6b19df2": {
"href": "https://example.ilucca.net/lucca-api/files/2face165-5345-4cf3-ab05-5421a6b19df2?token=eyXXXXXXXX&disposition=attachment",
"expiresAt": "2026-10-21T15:01:38.7634288Z",
"token": "eyXXXXXXXX"
}
}
}
}
},
"employment": {
"4561": {
"id": "4561",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/4561",
"remoteId": "EMPLOYMENT#4512-ac",
"employee": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"legalEntity": {
"id": "123",
"type": "legal-entity",
"url": "https://example.ilucca.net/lucca-api/legal-entities/123"
},
"status": "active",
"start": {
"date": "2024-01-01"
},
"end": null,
"document": {
"id": "9154c6a2-6105-4d5d-bfb6-5fd2d54037b3",
"type": "file",
"url": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3"
},
"template": {
"id": "4",
"type": "employment-template",
"url": "https://example.ilucca.net/lucca-api/employment-templates/4"
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"document": {
"href": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3?token=eyXXXXXXXX&disposition=json"
},
"jobPositions": {
"href": "https://example.ilucca.net/lucca-api/job-positions?employment.id=4561"
},
"probationaryPeriods": {
"href": "https://example.ilucca.net/lucca-api/probationary-periods?employment.id=4561"
},
"files": {
"9154c6a2-6105-4d5d-bfb6-5fd2d54037b3": {
"href": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3?token=eyXXXXXXXX&disposition=attachment",
"expiresAt": "2026-10-21T15:01:38.7634288Z",
"token": "eyXXXXXXXX"
}
}
}
}
}
}
}
},
"job-positions.post.example": {
"summary": "job-position POST example",
"description": "job-position POST example",
"value": {
"remoteId": null,
"employment": {
"id": "4561"
},
"startsOn": "2024-01-01",
"businessEstablishment": {
"id": "5"
},
"jobTitle": "Developer",
"jobQualification": {
"id": "982"
},
"manager": {
"id": "541"
},
"occupationCategory": {
"id": "12"
},
"workingTimeArrangement": {
"id": "23"
},
"department": {
"id": "32"
},
"document": null,
"notes": null,
"t9n": {
"jobTitle": {
"fr-FR": "Développeur"
}
}
}
},
"job-position.get.example": {
"summary": "job-position GET example",
"description": "job-position GET example",
"value": {
"id": "74",
"type": "job-position",
"url": "https://example.ilucca.net/lucca-api/job-positions/74",
"remoteId": null,
"employment": {
"id": "28",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/28"
},
"employee": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"status": "active",
"startsOn": "2024-01-01",
"endsOn": null,
"businessEstablishment": {
"id": "5",
"type": "business-establishment",
"url": "https://example.ilucca.net/lucca-api/business-establishments/5"
},
"jobTitle": "Developer",
"jobQualification": {
"id": "982",
"type": "job-qualification",
"url": "https://example.ilucca.net/lucca-api/job-qualifications/982"
},
"manager": {
"id": "541",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/541"
},
"occupationCategory": {
"id": "12",
"type": "occupation-category",
"url": "https://example.ilucca.net/lucca-api/occupation-categories/12"
},
"workingTimeArrangement": {
"id": "23",
"type": "working-time-arrangement",
"url": "https://example.ilucca.net/lucca-api/working-time-arrangements/23"
},
"department": {
"id": "32",
"type": "department",
"url": "https://example.ilucca.net/lucca-api/departments/32"
},
"document": {
"id": "c3b1f0de-7a42-4f8e-9d61-2b5e8a0f4c17",
"type": "file",
"url": "https://example.ilucca.net/lucca-api/files/c3b1f0de-7a42-4f8e-9d61-2b5e8a0f4c17"
},
"notes": null,
"t9n": {
"jobTitle": {
"fr-FR": "Développeur"
}
},
"updatedAttributes": [
"jobTitle",
"jobQualification"
],
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"document": {
"href": "https://example.ilucca.net/lucca-api/files/c3b1f0de-7a42-4f8e-9d61-2b5e8a0f4c17?token=eyXXXXXXXX&disposition=json"
},
"files": {
"c3b1f0de-7a42-4f8e-9d61-2b5e8a0f4c17": {
"href": "https://example.ilucca.net/lucca-api/files/c3b1f0de-7a42-4f8e-9d61-2b5e8a0f4c17?token=eyXXXXXXXX&disposition=attachment",
"expiresAt": "2026-10-21T15:01:38.7634288Z",
"token": "eyXXXXXXXX"
}
}
},
"embedded": {
"department": {
"32": {
"id": "32",
"type": "department",
"url": "https://example.ilucca.net/lucca-api/departments/32",
"name": "Finances",
"remoteId": "FIN",
"isArchived": false,
"parent": null,
"level": 1,
"manager": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"owningApplication": null,
"links": {}
}
},
"job-qualification": {
"982": {
"id": "982",
"type": "job-qualification",
"url": "https://example.ilucca.net/lucca-api/job-qualifications/982",
"title": "Lead Developer",
"profession": {
"id": "89",
"type": "profession",
"url": "https://example.ilucca.net/lucca-api/professions/89"
},
"rank": 2,
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {}
}
},
"employee": {
"416": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416",
"remoteId": "00002345",
"portrait": {
"id": "2face165-5345-4cf3-ab05-5421a6b19df2",
"type": "portrait",
"url": "https://example.ilucca.net/lucca-api/portraits/2face165-5345-4cf3-ab05-5421a6b19df2"
},
"givenName": "Edward",
"familyName": "Atkinson",
"employeeNumber": "E000124",
"status": "active",
"email": "eatkinson@acme.corp",
"birthDay": {
"day": 22,
"month": 12
},
"phoneNumber": "+33145784512",
"applicableEmployment": {
"id": "154",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/154"
},
"applicableJobPosition": {
"id": "74",
"type": "job-position",
"url": "https://example.ilucca.net/lucca-api/job-positions/74"
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"portrait": {
"href": "https://example.ilucca.net/lucca-api/files/2face165-5345-4cf3-ab05-5421a6b19df2?token=eyXXXXXXXX"
},
"employments": {
"href": "https://example.ilucca.net/lucca-api/employments?employee.id=416"
},
"jobPositions": {
"href": "https://example.ilucca.net/lucca-api/job-positions?employment.employee.id=416"
},
"personalRecord": {
"href": "https://example.ilucca.net/lucca-api/employee-personal-records?employee.id=416"
},
"files": {
"2face165-5345-4cf3-ab05-5421a6b19df2": {
"href": "https://example.ilucca.net/lucca-api/files/2face165-5345-4cf3-ab05-5421a6b19df2?token=eyXXXXXXXX&disposition=attachment",
"expiresAt": "2026-10-21T15:01:38.7634288Z",
"token": "eyXXXXXXXX"
}
}
}
}
},
"employment": {
"4561": {
"id": "4561",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/4561",
"remoteId": "EMPLOYMENT#4512-ac",
"employee": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416"
},
"legalEntity": {
"id": "123",
"type": "legal-entity",
"url": "https://example.ilucca.net/lucca-api/legal-entities/123"
},
"status": "active",
"start": {
"date": "2024-01-01"
},
"end": null,
"document": {
"id": "9154c6a2-6105-4d5d-bfb6-5fd2d54037b3",
"type": "file",
"url": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3"
},
"template": {
"id": "4",
"type": "employment-template",
"url": "https://example.ilucca.net/lucca-api/employment-templates/4"
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"links": {
"document": {
"href": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3?token=eyXXXXXXXX&disposition=json"
},
"jobPositions": {
"href": "https://example.ilucca.net/lucca-api/job-positions?employment.id=4561"
},
"probationaryPeriods": {
"href": "https://example.ilucca.net/lucca-api/probationary-periods?employment.id=4561"
},
"files": {
"9154c6a2-6105-4d5d-bfb6-5fd2d54037b3": {
"href": "https://example.ilucca.net/lucca-api/files/9154c6a2-6105-4d5d-bfb6-5fd2d54037b3?token=eyXXXXXXXX&disposition=attachment",
"expiresAt": "2026-10-21T15:01:38.7634288Z",
"token": "eyXXXXXXXX"
}
}
}
}
}
}
}
},
"job-position.patch.example": {
"summary": "job-position PATCH example",
"description": "job-position PATCH example",
"value": {
"jobTitle": "Developer",
"t9n": {
"jobTitle": {
"fr-FR": "Développeur"
}
}
}
},
"probationary-periods.get.example": {
"summary": "probationary-periods GET example",
"description": "probationary-periods GET example",
"value": {
"type": "probationary-periods",
"url": "https://example.ilucca.net/lucca-api/probationary-periods?limit=25",
"totalCount": 29,
"items": [
{
"id": "8721",
"type": "probationary-period",
"url": "https://example.ilucca.net/lucca-api/probationary-periods/8721",
"employment": {
"id": "4561",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/4561"
},
"startsOn": "2024-02-01",
"endsOn": "2024-07-31",
"initialEndsOn": "2024-04-30",
"extendedEndsOn": "2024-07-31",
"createdAt": "2024-03-24T08:21:35.001Z",
"lastUpdatedAt": "2024-03-24T08:21:35.001Z",
"links": {}
}
],
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/probationary-periods?page=!43df&limit=25",
"cursor": "!43df"
}
},
"embedded": {}
}
},
"probationary-period.post.example": {
"summary": "probationary-period POST example",
"description": "probationary-period POST example",
"value": {
"employment": {
"id": "4561"
},
"initialEndsOn": "2024-04-30"
}
},
"probationary-period.get.example": {
"summary": "probationary-period GET example",
"description": "probationary-period GET example",
"value": {
"id": "8721",
"type": "probationary-period",
"url": "https://example.ilucca.net/lucca-api/probationary-periods/8721",
"employment": {
"id": "4561",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/4561"
},
"startsOn": "2024-02-01",
"endsOn": "2024-07-31",
"initialEndsOn": "2024-04-30",
"extendedEndsOn": "2024-07-31",
"createdAt": "2024-03-24T08:21:35.001Z",
"lastUpdatedAt": "2024-03-24T08:21:35.001Z",
"links": {},
"embedded": {}
}
},
"probationary-period.patch.example": {
"summary": "probationary-period PATCH example",
"description": "probationary-period PATCH example",
"value": {
"extendedEndsOn": "2024-07-31"
}
},
"taxonomies.get.example": {
"summary": "taxonomies GET example",
"description": "taxonomies GET example",
"value": {
"type": "taxonomies",
"url": "https://example.ilucca.net/lucca-api/taxonomies?limit=25",
"totalCount": 872,
"items": [
{
"id": "45",
"type": "taxonomy",
"url": "https://example.ilucca.net/lucca-api/taxonomies/45",
"name": "T-shirt size",
"createdAt": "2025-01-23T19:45:23Z",
"lastUpdatedAt": "2025-01-23T19:45:23Z",
"t9n": {
"name": {
"fr-FR": "Taille de t-shirt."
}
},
"links": {}
}
],
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/taxonomies?page=2qs1dqsd45&limit=25",
"cursor": "2qs1dqsd45"
}
},
"embedded": {}
}
},
"taxonomies.post.example": {
"summary": "taxonomy POST example",
"description": "taxonomy POST example",
"value": {
"name": "T-shirt size",
"t9n": {
"name": {
"fr-FR": "Taille de t-shirt."
}
}
}
},
"taxonomy.get.example": {
"summary": "taxonomy GET example",
"description": "taxonomy GET example",
"value": {
"id": "45",
"type": "taxonomy",
"url": "https://example.ilucca.net/lucca-api/taxonomies/45",
"name": "T-shirt size",
"createdAt": "2025-01-23T19:45:23Z",
"lastUpdatedAt": "2025-01-23T19:45:23Z",
"t9n": {
"name": {
"fr-FR": "Taille de t-shirt."
}
},
"links": {},
"embedded": {}
}
},
"taxonomy.patch.example": {
"summary": "taxonomy PATCH example",
"description": "taxonomy PATCH example",
"value": {
"name": "T-shirt size",
"t9n": {
"name": {
"fr-FR": "Taille de t-shirt."
}
}
}
},
"taxonomy-labels.get.example": {
"summary": "taxonomy-labels GET example",
"description": "taxonomy-labels GET example",
"value": {
"type": "taxonomy-labels",
"url": "https://example.ilucca.net/lucca-api/taxonomy-labels?limit=25",
"totalCount": 872,
"items": [
{
"id": "8751",
"type": "taxonomy-label",
"url": "https://example.ilucca.net/lucca-api/taxonomy-labels/8751",
"taxonomy": {
"id": "45",
"type": "taxonomy",
"url": "https://example.ilucca.net/lucca-api/taxonomies/45"
},
"name": "XL",
"remoteId": "tshirtSize.extraLarge",
"createdAt": "2025-01-23T19:45:23Z",
"lastUpdatedAt": "2025-01-23T19:45:23Z",
"isArchived": false,
"lastArchivedAt": null,
"t9n": {},
"links": {}
}
],
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/taxonomy-labels?page=2qs1dqsd45&limit=25",
"cursor": "2qs1dqsd45"
}
},
"embedded": {}
}
},
"taxonomy-labels.post.example": {
"summary": "taxonomy-label POST example",
"description": "taxonomy-label POST example",
"value": {
"taxonomy": {
"id": "45"
},
"name": "XL",
"remoteId": "tshirtSize.extraLarge",
"t9n": {
"name": {
"fr-FR": "Très grand (XL)"
}
}
}
},
"taxonomy-label.get.example": {
"summary": "taxonomy-label GET example",
"description": "taxonomy-label GET example",
"value": {
"id": "8751",
"type": "taxonomy-label",
"url": "https://example.ilucca.net/lucca-api/taxonomy-labels/8751",
"taxonomy": {
"id": "45",
"type": "taxonomy",
"url": "https://example.ilucca.net/lucca-api/taxonomies/45"
},
"name": "XL",
"remoteId": "tshirtSize.extraLarge",
"createdAt": "2025-01-23T19:45:23Z",
"lastUpdatedAt": "2025-01-23T19:45:23Z",
"isArchived": false,
"lastArchivedAt": null,
"t9n": {},
"links": {},
"embedded": {}
}
},
"taxonomy-label.patch.example": {
"summary": "taxonomy-label PATCH example",
"description": "taxonomy-label PATCH example",
"value": {
"name": "XL",
"remoteId": "tshirtSize.extraLarge",
"t9n": {
"name": {
"fr-FR": "Très grand (XL)"
}
}
}
},
"working-time-arrangements.get.example": {
"summary": "working-time-arrangements GET example",
"description": "working-time-arrangements GET example",
"value": {
"type": "working-time-arrangements",
"url": "https://example.ilucca.net/lucca-api/working-time-arrangements?limit=25",
"totalCount": 456,
"items": [
{
"id": "237",
"type": "working-time-arrangement",
"url": "https://example.ilucca.net/lucca-api/working-time-arrangements/237",
"name": "Standard - 35H / week",
"publicHolidaysCalendar": {
"id": "3",
"type": "public-holidays-calendar",
"url": "https://example.ilucca.net/lucca-api/public-holidays-calendars/3"
},
"isArchived": false
}
],
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/working-time-arrangements?page=!984fdgx&limit=25",
"cursor": "!984fdgx"
}
},
"embedded": {}
}
},
"working-time-arrangement.get.example": {
"summary": "working-time-arrangement GET example",
"description": "working-time-arrangement GET example",
"value": {
"id": "237",
"type": "working-time-arrangement",
"url": "https://example.ilucca.net/lucca-api/working-time-arrangements/237",
"name": "Standard - 35H / week",
"publicHolidaysCalendar": {
"id": "3",
"type": "public-holidays-calendar",
"url": "https://example.ilucca.net/lucca-api/public-holidays-calendars/3"
},
"isArchived": false,
"links": {},
"embedded": {}
}
},
"events.get.example": {
"summary": "events GET example",
"description": "events GET example",
"value": {
"type": "events",
"url": "https://example.ilucca.net/lucca-api/events?limit=25",
"totalCount": 483,
"items": [
{
"id": "123",
"type": "event",
"url": "https://example.ilucca.net/lucca-api/events/123",
"apiVersion": "2024-01-01",
"topic": "employee.updated",
"occurredAt": "2024-02-01T09:34:23.001Z",
"source": "https://example.ilucca.net",
"businessEstablishment": {
"id": "12",
"type": "business-establishment",
"url": "https://example.ilucca.net/lucca-api/business-establishments/12"
},
"data": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416",
"remoteId": "00002345",
"portrait": {
"id": "2face165-5345-4cf3-ab05-5421a6b19df2",
"type": "portrait",
"url": "https://example.ilucca.net/lucca-api/portraits/2face165-5345-4cf3-ab05-5421a6b19df2"
},
"givenName": "Edward",
"familyName": "Atkinson",
"employeeNumber": "E000124",
"status": "active",
"email": "eatkinson@acme.corp",
"birthDay": {
"day": 22,
"month": 12
},
"phoneNumber": "+33145784512",
"applicableEmployment": {
"id": "154",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/154"
},
"applicableJobPosition": {
"id": "74",
"type": "job-position",
"url": "https://example.ilucca.net/lucca-api/job-positions/74"
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
"previousAttributes": {
"givenName": "Ed"
}
},
"links": {
"retry": {
"href": "https://example.ilucca.net/lucca-api/webhook-deliveries"
}
}
}
],
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/events?page=!sdk87Sdh&limit=25",
"cursor": "!sdk87Sdh"
}
},
"embedded": {}
}
},
"event.get.example": {
"summary": "event GET example",
"description": "event GET example",
"value": {
"id": "123",
"type": "event",
"url": "https://example.ilucca.net/lucca-api/events/123",
"apiVersion": "2024-01-01",
"topic": "employee.updated",
"occurredAt": "2024-02-01T09:34:23.001Z",
"source": "https://example.ilucca.net",
"businessEstablishment": {
"id": "12",
"type": "business-establishment",
"url": "https://example.ilucca.net/lucca-api/business-establishments/12"
},
"data": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416",
"remoteId": "00002345",
"portrait": {
"id": "2face165-5345-4cf3-ab05-5421a6b19df2",
"type": "portrait",
"url": "https://example.ilucca.net/lucca-api/portraits/2face165-5345-4cf3-ab05-5421a6b19df2"
},
"givenName": "Edward",
"familyName": "Atkinson",
"employeeNumber": "E000124",
"status": "active",
"email": "eatkinson@acme.corp",
"birthDay": {
"day": 22,
"month": 12
},
"phoneNumber": "+33145784512",
"applicableEmployment": {
"id": "154",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/154"
},
"applicableJobPosition": {
"id": "74",
"type": "job-position",
"url": "https://example.ilucca.net/lucca-api/job-positions/74"
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z"
},
"previousAttributes": {
"givenName": "Ed"
},
"links": {
"retry": {
"href": "https://example.ilucca.net/lucca-api/webhook-deliveries"
}
}
}
},
"webhook-endpoints.get.example": {
"summary": "webhook-endpoints GET example",
"description": "webhook-endpoints GET example",
"value": {
"type": "webhook-endpoints",
"url": "https://example.ilucca.net/lucca-api/webhook-endpoints?limit=25",
"totalCount": 12,
"items": [
{
"id": "456789412",
"type": "webhook-endpoint",
"url": "https://example.ilucca.net/lucca-api/webhook-endpoints/93847DF7FDSF6D87SF",
"name": "Test",
"apiVersion": "2024-11-01",
"webhookUrl": "https://i-am-aweso.me/lucca-webhooks/123",
"topics": [
"employee.created",
"employee.updated"
],
"status": "active",
"createdAt": "2023-04-23T09:23:54.001Z",
"lastUpdatedAt": "2023-04-23T09:23:54.001Z",
"links": {}
}
],
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/webhook-endpoints?page=!98438df&limit=25",
"cursor": "!98438df"
}
},
"embedded": {}
}
},
"webhook-endpoints.post.example": {
"summary": "webhook-endpoint POST example",
"description": "webhook-endpoint POST example",
"value": {
"name": "Test",
"webhookUrl": "https://i-am-aweso.me/lucca-webhooks/123",
"apiVersion": "2024-11-01",
"businessEstablishments": null,
"topics": [
"employee.created",
"employee.updated"
],
"status": "active"
}
},
"webhook-endpoints.post.resp.example": {
"summary": "webhook-endpoint POST response example",
"description": "webhook-endpoint POST response example",
"value": {
"id": "456789412",
"type": "webhook-endpoint",
"url": "https://example.ilucca.net/lucca-api/webhook-endpoints/93847DF7FDSF6D87SF",
"name": "Test",
"apiVersion": "2024-11-01",
"webhookUrl": "https://i-am-aweso.me/lucca-webhooks/123",
"topics": [
"employee.created",
"employee.updated"
],
"status": "active",
"secret": "b3YGydKxao0CYEg4-2LM81rviT-vl2JzKyf_zlewRn0cpoHzh4mRLj5_Ty5neQta",
"createdAt": "2023-04-23T09:23:54.001Z",
"lastUpdatedAt": "2023-04-23T09:23:54.001Z",
"links": {}
}
},
"webhook-endpoint.get.example": {
"summary": "webhook-endpoint GET example",
"description": "webhook-endpoint GET example",
"value": {
"id": "456789412",
"type": "webhook-endpoint",
"url": "https://example.ilucca.net/lucca-api/webhook-endpoints/93847DF7FDSF6D87SF",
"name": "Test",
"apiVersion": "2024-11-01",
"webhookUrl": "https://i-am-aweso.me/lucca-webhooks/123",
"topics": [
"employee.created",
"employee.updated"
],
"status": "active",
"createdAt": "2023-04-23T09:23:54.001Z",
"lastUpdatedAt": "2023-04-23T09:23:54.001Z",
"links": {},
"embedded": {}
}
},
"webhook-endpoint.patch.example": {
"summary": "webhook-endpoint PATCH example",
"description": "webhook-endpoint PATCH example",
"value": {
"name": "Test 2",
"apiVersion": "2024-11-01",
"webhookUrl": "https://i-am-aweso.me/lucca-webhooks/123",
"topics": [
"employee.created",
"employee.updated"
],
"status": "active"
}
},
"webhook-deliveries.get.example": {
"summary": "webhook-deliveries GET example",
"description": "webhook-deliveries GET example",
"value": {
"type": "webhook-deliveries",
"url": "https://example.ilucca.net/lucca-api/webhook-deliveries?limit=25",
"totalCount": 29,
"items": [
{
"id": "78fa5d8c-3436-49aa-82cc-ab1a64c48ed9",
"type": "webhook-delivery",
"url": "https://example.ilucca.net/lucca-api/webhook-deliveries/78fa5d8c-3436-49aa-82cc-ab1a64c48ed9",
"nextAttemptAt": "2023-08-29T09:12:33.001Z",
"attemptsCount": 2,
"status": "delivered",
"event": {
"id": "2455623",
"type": "event",
"url": "https://example.ilucca.net/lucca-api/events/2455623"
},
"webhookEndpoint": {
"id": "12",
"type": "webhook-endpoint",
"url": "https://example.ilucca.net/lucca-api/webhook-endpoints/12"
},
"links": {
"attempts": {
"href": "https://example.ilucca.net/lucca-api/webhook-delivery-attempts?webhookDelivery.id=78fa5d8c-3436-49aa-82cc-ab1a64c48ed9"
}
}
}
],
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/webhook-deliveries?page=!43df&limit=25",
"cursor": "!43df"
}
},
"embedded": {}
}
},
"webhook-delivery.post.example": {
"summary": "webhook-delivery POST example",
"description": "webhook-delivery POST example",
"value": {
"webhookEndpoint": {
"id": "12"
}
}
},
"webhook-delivery.get.example": {
"summary": "webhook-delivery GET example",
"description": "webhook-delivery GET example",
"value": {
"id": "78fa5d8c-3436-49aa-82cc-ab1a64c48ed9",
"type": "webhook-delivery",
"url": "https://example.ilucca.net/lucca-api/webhook-deliveries/78fa5d8c-3436-49aa-82cc-ab1a64c48ed9",
"nextAttemptAt": "2023-08-29T09:12:33.001Z",
"attemptsCount": 2,
"status": "delivered",
"event": {
"id": "2455623",
"type": "event",
"url": "https://example.ilucca.net/lucca-api/events/2455623"
},
"webhookEndpoint": {
"id": "12",
"type": "webhook-endpoint",
"url": "https://example.ilucca.net/lucca-api/webhook-endpoints/12"
},
"links": {
"attempts": {
"href": "https://example.ilucca.net/lucca-api/webhook-delivery-attempts?webhookDelivery.id=78fa5d8c-3436-49aa-82cc-ab1a64c48ed9"
}
},
"embedded": {}
}
},
"webhook-delivery-attempts.get.example": {
"summary": "webhook-delivery-attempts GET example",
"description": "webhook-delivery-attempts GET example",
"value": {
"type": "webhook-delivery-attempts",
"url": "https://example.ilucca.net/lucca-api/webhook-delivery-attempts?limit=25",
"totalCount": 29,
"items": [
{
"id": "874",
"type": "webhook-delivery-attempt",
"url": "https://example.ilucca.net/lucca-api/webhook-delivery-attempts/874",
"signature": "9087FD897DSF87D67F78SD6F876SD78F6SD7886F78SD6F87SD678F6SD78F6SD786FS876F78SD6F786FYJHXWYCV78C6FV7868S7FDS78",
"webhookDelivery": {
"id": "87",
"type": "webhook-delivery",
"url": "https://example.ilucca.net/lucca-api/webhook-deliveries/87"
},
"isSuccessful": true,
"responseStatusCode": 202,
"errorResponseBody": "",
"createdAt": "2024-04-03T09:23:56.235Z",
"links": {}
}
],
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/webhook-delivery-attempts?page=!43df&limit=25",
"cursor": "!43df"
}
},
"embedded": {
"webhook-delivery": {
"87": {
"id": "87",
"type": "webhook-delivery",
"url": "https://example.ilucca.net/lucca-api/webhook-deliveries/87",
"nextAttemptAt": "2023-08-29T09:12:33.001Z",
"attemptsCount": 2,
"status": "delivered",
"event": {
"id": "123",
"type": "event",
"url": "https://example.ilucca.net/lucca-api/events/123"
},
"webhookEndpoint": {
"id": "12",
"type": "webhook-endpoint",
"url": "https://example.ilucca.net/lucca-api/webhook-endpoints/12"
},
"links": {
"attempts": {
"href": "https://example.ilucca.net/lucca-api/webhook-delivery-attempts?webhookDelivery.id=87"
}
}
}
},
"event": {
"123": {
"id": "123",
"type": "event",
"url": "https://example.ilucca.net/lucca-api/events/123",
"apiVersion": "2024-01-01",
"topic": "employee.updated",
"occurredAt": "2024-02-01T09:34:23.001Z",
"source": "https://example.ilucca.net",
"businessEstablishment": {
"id": "12",
"type": "business-establishment",
"url": "https://example.ilucca.net/lucca-api/business-establishments/12"
},
"data": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416",
"remoteId": "00002345",
"portrait": {
"id": "2face165-5345-4cf3-ab05-5421a6b19df2",
"type": "portrait",
"url": "https://example.ilucca.net/lucca-api/portraits/2face165-5345-4cf3-ab05-5421a6b19df2"
},
"givenName": "Edward",
"familyName": "Atkinson",
"employeeNumber": "E000124",
"status": "active",
"email": "eatkinson@acme.corp",
"birthDay": {
"day": 22,
"month": 12
},
"phoneNumber": "+33145784512",
"applicableEmployment": {
"id": "154",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/154"
},
"applicableJobPosition": {
"id": "74",
"type": "job-position",
"url": "https://example.ilucca.net/lucca-api/job-positions/74"
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z"
},
"previousAttributes": {
"givenName": "Ed"
},
"links": {
"retry": {
"href": "https://example.ilucca.net/lucca-api/webhook-deliveries"
}
}
}
}
}
}
},
"webhook-delivery-attempt.get.example": {
"summary": "webhook-delivery-attempt GET example",
"description": "webhook-delivery-attempt GET example",
"value": {
"id": "874",
"type": "webhook-delivery-attempt",
"url": "https://example.ilucca.net/lucca-api/webhook-delivery-attempts/874",
"signature": "9087FD897DSF87D67F78SD6F876SD78F6SD7886F78SD6F87SD678F6SD78F6SD786FS876F78SD6F786FYJHXWYCV78C6FV7868S7FDS78",
"webhookDelivery": {
"id": "87",
"type": "webhook-delivery",
"url": "https://example.ilucca.net/lucca-api/webhook-deliveries/87"
},
"isSuccessful": true,
"responseStatusCode": 202,
"errorResponseBody": "",
"createdAt": "2024-04-03T09:23:56.235Z",
"links": {},
"embedded": {
"webhook-delivery": {
"87": {
"id": "87",
"type": "webhook-delivery",
"url": "https://example.ilucca.net/lucca-api/webhook-deliveries/87",
"nextAttemptAt": "2023-08-29T09:12:33.001Z",
"attemptsCount": 2,
"status": "delivered",
"event": {
"id": "123",
"type": "event",
"url": "https://example.ilucca.net/lucca-api/events/123"
},
"webhookEndpoint": {
"id": "12",
"type": "webhook-endpoint",
"url": "https://example.ilucca.net/lucca-api/webhook-endpoints/12"
},
"links": {
"attempts": {
"href": "https://example.ilucca.net/lucca-api/webhook-delivery-attempts?webhookDelivery.id=87"
}
}
}
},
"event": {
"123": {
"id": "123",
"type": "event",
"url": "https://example.ilucca.net/lucca-api/events/123",
"apiVersion": "2024-01-01",
"topic": "employee.updated",
"occurredAt": "2024-02-01T09:34:23.001Z",
"source": "https://example.ilucca.net",
"businessEstablishment": {
"id": "12",
"type": "business-establishment",
"url": "https://example.ilucca.net/lucca-api/business-establishments/12"
},
"data": {
"id": "416",
"type": "employee",
"url": "https://example.ilucca.net/lucca-api/employees/416",
"remoteId": "00002345",
"portrait": {
"id": "2face165-5345-4cf3-ab05-5421a6b19df2",
"type": "portrait",
"url": "https://example.ilucca.net/lucca-api/portraits/2face165-5345-4cf3-ab05-5421a6b19df2"
},
"givenName": "Edward",
"familyName": "Atkinson",
"employeeNumber": "E000124",
"status": "active",
"email": "eatkinson@acme.corp",
"birthDay": {
"day": 22,
"month": 12
},
"phoneNumber": "+33145784512",
"applicableEmployment": {
"id": "154",
"type": "employment",
"url": "https://example.ilucca.net/lucca-api/employments/154"
},
"applicableJobPosition": {
"id": "74",
"type": "job-position",
"url": "https://example.ilucca.net/lucca-api/job-positions/74"
},
"createdAt": "2024-04-15T23:12:54.0001Z",
"lastUpdatedAt": "2024-04-15T23:12:54.0001Z"
},
"previousAttributes": {
"givenName": "Ed"
},
"links": {
"retry": {
"href": "https://example.ilucca.net/lucca-api/webhook-deliveries"
}
}
}
}
}
}
}
}
},
"x-mcp": {
"enabled": true
}
}