GET
/
api
/
v3
/
users
curl --request GET \
  --url https://{host}/api/v3/users \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "items": [
    {
      "id": 123,
      "name": "<string>",
      "url": "<string>",
      "displayName": "<string>",
      "modifiedOn": "<string>",
      "lastName": "<string>",
      "firstName": "<string>",
      "login": "<string>",
      "mail": "<string>",
      "dtContractStart": "<string>",
      "dtContractEnd": null,
      "birthDate": "<string>",
      "employeeNumber": "<string>",
      "calendar": {
        "id": 123,
        "url": "<string>",
        "name": "<string>"
      },
      "culture": {
        "id": 123,
        "name": "<string>",
        "url": "<string>"
      },
      "picture": {
        "id": "<string>",
        "href": "<string>"
      },
      "applicationData": {},
      "legalEntity": {
        "id": 123,
        "name": "<string>",
        "url": "<string>"
      },
      "department": {
        "id": 123,
        "name": "<string>",
        "url": "<string>"
      },
      "manager": {
        "id": 123,
        "name": "<string>",
        "url": "<string>"
      },
      "rolePrincipal": {
        "id": 123,
        "name": "<string>",
        "url": "<string>"
      },
      "habilitedRoles": [
        {
          "id": 123,
          "name": "<string>",
          "url": "<string>"
        }
      ],
      "userWorkCycles": [
        {
          "Id": 123,
          "OwnerID": 123,
          "WorkCycleID": 123,
          "StartsOn": "<string>",
          "EndsOn": "<string>"
        }
      ]
    }
  ]
}

Headers

​
Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Query Parameters

​
dtContractEnd
string

{comparator},{date-time}.

​
dtContractStart
string

{comparator},{date-time}

​
id
string

User's identifier

​
modifiedAt
string

{comparator},{date-time}

​
paging
string

{offset},{limit}. Defaults to 0,1000.

​
fields
string

Comma-separated list of fields to include in the response.

​
mail
string

User's mail

​
login
string

User's login

Body

application/json · object

Response

200
application/json

OK

The response is of type object.