Skip to main content
GET
/
cloud-gateway
/
v1
/
persons
cURL
curl --request GET \
  --url http://localhost:8080/cloud-gateway/v1/persons
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "academicTitle": "Dr.",
    "firstName": "Max",
    "middleName": "Moritz",
    "lastName": "Mustermann",
    "prefixToLastName": "zum",
    "titleOfNobility": "Baron",
    "suffixToLastName": "junior",
    "gender": "FEMALE",
    "dateOfBirth": "2023-06-14",
    "citizenship": "DE",
    "address": {
      "street": "Carl-Zeiss-Straße",
      "houseNumber": 14,
      "additionalAddressInfo": "<string>",
      "zipCode": 52477,
      "city": "Alsdorf",
      "stateCode": "DE-NW",
      "country": "DE"
    },
    "businessEmail": "[email protected]",
    "groupEntryDate": "1999-02-31",
    "expectedStartOfPension": "2099-12-31",
    "employeeNumber": 56,
    "jobTitle": "Integrations Team Lead",
    "managerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customFields": [
      {
        "name": "<string>",
        "type": "STRING",
        "textValue": "<string>",
        "numberValue": 123,
        "booleanValue": true,
        "dateValue": "2023-12-25",
        "selection": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ]
      }
    ],
    "payrollContractIds": [
      "<string>"
    ]
  }
]
In many fields, you will see two systems listed in a specific order. These lists indicate the order of precedence of the systems. The returned value is taken from the first system in the list that is deployed in your environment, regardless of where information has been stored.Payroll and Time & Security data can only be retrieved if the person mappings have been configured in the VEDA Horizon Platform. If multiple contracts are active, the primary employment is used.

Query Parameters

​
modifiedSince
string<date-time>

Only persons whose data has changed since this date are included in the results. The returned elements only contain information from systems in which changes have occurred; they do not contain complete person data. This enables us to produce faster results. If you feel that this should change, please provide us with feedback.

Response

200 - */*

OK

​
id
string<uuid>

Unique identifier. Matches the ID of the person in the VEDA Horizon (Base) API

​
academicTitle
string
  1. Payroll Expert - LPTITL
  2. Platform - Personal information > General (Formerly title)
Maximum string length: 80
Example:

"Dr."

​
firstName
string
  1. Payroll Expert - LPVNAM
  2. Platform - Personal information > General
Maximum string length: 80
Example:

"Max"

​
middleName
string
  1. Payroll Expert includes the middle name in the firstName field. If present, this field is always empty.
  2. Platform - Personal information > General
Maximum string length: 80
Example:

"Moritz"

​
lastName
string
  1. Payroll Expert - LPNAME
  2. Platform - Personal information > General
Maximum string length: 80
Example:

"Mustermann"

​
prefixToLastName
string
  1. Payroll Expert - LPVSWO
  2. Platform - Personal information > General (Formerly namePrefix)
Maximum string length: 80
Example:

"zum"

​
titleOfNobility
string
  1. Payroll Expert - LPNMZU
  2. Platform - Personal information > General (Formerly nameAffix)
Maximum string length: 80
Example:

"Baron"

​
suffixToLastName
string

E.g. additions like senior, junior, or suffixed academic titles like M.Sc., M.A., abbreviations of religious orders like SJ, or abbreviations of public offices like MP

  1. Platform - Personal information > General (Formerly titlePostPositioned)
Maximum string length: 80
Example:

"junior"

​
gender
enum<string>

Gender according to birth certificate or passport

  1. Payroll Expert - LPGENU
  2. Platform - Personal information > General
Available options:
MALE,
FEMALE,
INTERSEX,
UNSPECIFIED
Example:

"FEMALE"

​
dateOfBirth
string<date>
  1. Payroll Expert - LPGBDT
  2. Platform - Personal information > General
Example:

"2023-06-14"

​
citizenship
string<ISO 3166-1 alpha-2>
  1. Payroll Expert - LPSTAA
  2. Platform - Personal information > General
Required string length: 2
Example:

"DE"

​
address
StreetAddress · object
  1. Payroll Expert
  2. Platform - Personal information > Personal contact information
​
businessEmail
string<email>

The standard business email address

  1. Platform - Business information > Business contact details
Maximum string length: 254
Example:

"[email protected]"

​
groupEntryDate
string<date>

Start of first employment with the organisation

  1. Platform - Business information > General (Formerly enterpriseEntryDate)
Example:

"1999-02-31"

​
expectedStartOfPension
string<date>
  1. Platform - Business information > General
Example:

"2099-12-31"

​
employeeNumber
string
  1. Platform - Business information > General
Maximum string length: 20
Example:

56

​
jobTitle
string
  1. Platform - Business information > General (Formerly employmentTitleDisplayName)
Maximum string length: 400
Example:

"Integrations Team Lead"

​
managerId
string<uuid>

Person id of the disciplinary manager. Further information about the manager (as person) can be retrieved using this id

  1. Platform - Business information > General
​
customFields
object[]

Custom fields of the person. Before any custom fields can be returned, you need to configure the API to include the fields you need. This can be done in the Platform under Administration > Basics > External applications > Second icon in the action column.

​
payrollContractIds
string[]

Contract ids are used to identify individuals in the payroll system. One person can have multiple payroll contracts, e.g. if they have multiple jobs or roles in the organization. In the case of bulk queries, this list may contain values that are not available in Payroll. In this case, please correct the person mappings in VEDA Horizon. In the past, payroll contracts were identified using a combination of the company and employee number. Currently, the ids are in the form 'companyId-employeeNumber'. You can use this information if you already have it, but it may not be stable in the future.