Retrieve the details of an existing person by its ID

GET/people/{id}

Last modified: 18 days ago

Request

Path Params

string

required

Header Params

X-Integration-Name

string

required

Integration name

Example:

API Documentation

X-Integration-Provider

string

required

Integration provider

Example:

cobra GmbH

X-Cobra-TenantId

string

required

Tenant ID

Example:

12e39e53-ece1-4d8d-8958-e782de1dbef0

X-Integration-Contact

string

optional

Integration contact

Example:

info@cobra.de

Accept-Language

string

optional

Example:

Request samples

Responses

OK(200)

Not Found(404)

HTTP Code: 200

Content Type : JSONapplication/json

data

object (PeopleWithResponsibleForObjects)

optional

DTO for representing a person with a list of objects, they are responsible for.

createdBy

string | null

optional

modifiedBy

string | null

optional

dateCreated

string <date-time> | null

optional

dateModified

string <date-time> | null

optional

createdByUserId

string <uuid> | null

optional

modifiedByUserId

string <uuid> | null

optional

string | null

optional

The ID of the person.

salutation

string | null

optional

The salutation of the person.

title

string | null

optional

The title of the person.

firstname

string | null

optional

The first name of the person.

lastname

string | null

optional

The last name of the person.

birthday

object (PeopleBirthdayDto)

optional

importantDates

array[object (PeopleImportantDate) {2}] | null

optional

The List of important dates.

socialMedias

array[object (PeopleSocialMedia) {2}] | null

optional

The List of social media informations.

orgaTags

array[object (CobraTagForEmbeddedDto) {2}] | null

optional

The List of orga tags.

personalities

array[object (EmbeddedPersonality) {3}] | null

optional

The List of personalities.

customerNumber

string | null

optional

The customer number.

note

object (PeopleNote)

optional

Transfer Object for representing a note associated with a person

cards

array[object (BusinessCard) {17}] | null

optional

The List of business cards.

relations

array[object (Relation) {2}] | null

optional

The List of relations.

userMail

string | null

optional

The email address of the user from user management.
Otherwise, the email address will be stored in a business card.

employeeStatus

string | null

optional

The employee status of the person.

userId

string <uuid> | null

optional

User ID of the person, which is from user management.

lifecycle

object (PeopleLifecycleForOutput)

optional

Output Object for lifecycle information

lifecycleHistories

array[object (PeopleLifecycleForOutput) {4}] | null

optional

The List of lifecycle histories associated with the people object.

profileImage

string | null

optional

The profile image of the person.

employeeNumber

string | null

optional

initials

string | null

read-onlyoptional

The initials of the person, generated from the first and last name.

detailImagePath

string | null

read-onlyoptional

The path to the detailed profile image of the person.

name

string | null

read-onlyoptional

Combination field: "Lastname, Firstname"

responsibleForList

array[object (ResponsibleFor) {9}] | null

optional

The list of objects that the person is responsible for.

message

string | null

optional

metaData

object (ResponseMetaData)

optional

totalResults

integer <int32>

optional

responseTimeStamp

string <date-time>

optional

statusCode

integer <int32>

optional

Not configured

Last modified: 18 days ago