List employment-templates

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

{
  "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-extension-definitions?extends.type=employment-template&extendedEmploymentTemplate.id=12"
        }
      }
    }
  ],
  "links": {
    "prev": null,
    "next": {
      "href": "https://example.ilucca.net/lucca-api/employment-templates?page=!sdk87Sdh&limit=25"
    }
  },
  "embedded": {}
}

GET

lucca-api

employment-templates

List employment-templates

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

{
  "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-extension-definitions?extends.type=employment-template&extendedEmploymentTemplate.id=12"
        }
      }
    }
  ],
  "links": {
    "prev": null,
    "next": {
      "href": "https://example.ilucca.net/lucca-api/employment-templates?page=!sdk87Sdh&limit=25"
    }
  },
  "embedded": {}
}

Security: OAuth 2.0

Scopes:

- employment-templates.readonly
- employment-templates.readwrite

Business-establishments: Any of the employment-template business-establishments.

About authentication

Authorizations

Authorization

string

header

required

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

Headers

Api-Version

enum<string>

required

Set the API version.

Available options:

2024-11-01

Allowed value: "2024-11-01"

Maximum string length: 10

If-None-Match

string

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

If-Match

string

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

Accept-Encoding

string

List of compression algorithms you support.

Query Parameters

page

string

Cursor of the page to retrieve. Read more about pagination.

limit

integer

default:25

Number of items per page. Defaults to 25. Maximum is 100. Read more about pagination.

Required range: 0 <= x <= 100

include

enum<string>[]

Include metadata:

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

Response

A collection of employment-template resources.

type

string

required

Allowed value: "employment-templates"

url

string<uri>

required

items

employment-template · object[]

required

Maximum array length: 100

Show child attributes

items.title

string

required

Minimum string length: 1

items.legalEntities

Reference to a legal-entity · object[]

required

Reserve this employment-template to a subset of legal-entities. Leave empty if this template should be available to ALL legal-entities.

Show child attributes

items.legalEntities.id

string

required

Minimum string length: 1

items.legalEntities.type

enum<string>

Available options:

legal-entity

Allowed value: "legal-entity"

items.legalEntities.url

string<uri>

items.term

enum<string>

required

Term of an employment.

Available options:

permanent,

fixed

items.audience

enum<string>

default:employee

required

Available options:

employee,

student,

external,

elected,

appointee,

associate,

volunteer,

other

items.id

string

Minimum string length: 1

items.type

string

Allowed value: "employment-template"

items.url

string<uri>

items.t9n

object

Show child attributes

items.t9n.title

Translations · object

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.

On 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.

Languages are identified through their RFC 4646 language tag.

Show child attributes

items.t9n.title.de-DE

string | null

German (Germany)

items.t9n.title.en-US

string | null

English (United States of America)

items.t9n.title.en-GB

string | null

English (Great Britain)

items.t9n.title.es-ES

string | null

Spanish (Spain)

items.t9n.title.fr-FR

string | null

French (France)

items.t9n.title.fr-CH

string | null

French (Switzerland)

items.t9n.title.it-IT

string | null

Italian (Italy)

items.t9n.title.nl-BE

string | null

Dutch (Belgium)

items.t9n.title.nl-NL

string | null

Dutch (Netherlands)

items.t9n.title.pt-PT

string | null

Portuguese (Portugal)

items.createdAt

string<date-time-offset>

Read-only. UTC timestamp of the moment this object was created.

items.lastUpdatedAt

string<date-time>

Read-only. UTC timestamp of the moment this object was last updated. Set upon creation, update or deletion of the object.

items.links

object

Show child attributes

items.links.extensionDefinitions

Link · object

Object that represents an hyperlink.

Show child attributes

items.links.extensionDefinitions.href

string<uri>

required

URL to the related object.

totalCount

integer<int64> | null

Total number of employment-template resources across all pages that satisfy query parameters.

Required range: x >= 0

embedded

object

links

Links · object

Links to related resources

Show child attributes

links.prev

Link · object

required

Link to the previous page. Is null on the first page.

Show child attributes

links.prev.href

string<uri>

required

URL to the related object.

links.next

Link · object

required

Link to the next page. Is null on the last page.

Show child attributes

links.next.href

string<uri>

required

URL to the related object.

The employment-template resource

Retrieve an employment-template

⌘I

Overview

Organization

Employee Records

Events & Webhooks

List employment-templates

Authorizations

Headers

Query Parameters

Response