# Person

## Retrieves the collection of Person resources.

> Retrieves the collection of Person resources.

```json
{"openapi":"3.0.0","info":{"title":"Converia API","version":"3.5.0"},"servers":[{"url":"/","description":""}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Person.PersonDTO.jsonld-person.read_address.read_person.read-extended_translation":{"type":"object","description":"Person","properties":{"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"id":{"description":"The unique identifier for the person entity","type":"integer"},"externalId":{"description":"The external ID used for referencing external accounts","type":"string"},"firstname":{"description":"The persons firstname","type":"string"},"lastname":{"description":"The persons surname","type":"string"},"foaType":{"$ref":"#/components/schemas/FoaType","description":"Foa type of the person","type":"string"},"academicPrefix":{"description":"The persons academic title","type":"string"},"academicSuffix":{"description":"The persons name suffix, additional information","type":"string"},"customSalutation":{"type":"array","items":{"$ref":"#/components/schemas/TranslationDTO.jsonld-person.read_address.read_person.read-extended_translation"}},"genderspecificFormOfAddressPart":{"$ref":"#/components/schemas/LegacyGenderSpecificFoaPart","description":"The persons form of address","type":"string"},"birthday":{"description":"The persons birthday","type":"string","format":"date-time","nullable":true},"function":{"description":"The persons function / job / responsibility","type":"string"},"efn":{"description":"The persons unified training number","type":"string"},"lastUpdated":{"description":"Last change of the person or address infos","type":"string","format":"date-time"},"textVita":{"description":"Vita of a person","type":"string"},"gender":{"$ref":"#/components/schemas/LegacyGenderType","description":"Gender of the person, not stored in most cases","deprecated":true,"type":"string"},"memberId":{"description":"A global frame independet member id, not connected with the member management","type":"string"},"membership":{"description":"Institution the member id belongs to","type":"string"},"isMarkedDeleted":{"description":"Marker for deleted person","type":"boolean"},"isMarkedImported":{"description":"Marker for imported person","type":"boolean"},"additionalTextInfo":{"description":"Some additional plain text info","type":"string"},"accountType":{"$ref":"#/components/schemas/AccountType","description":"Type of account","type":"string"},"account":{"description":"The Account","type":"string","format":"iri-reference"},"mergedToPerson":{"description":"If person is merged, the link to the merge result","type":"string","format":"iri-reference","nullable":true},"language":{"description":"The persons language","type":"string","format":"iri-reference","nullable":true},"address":{"description":"The persons address","$ref":"#/components/schemas/AddressDTO.jsonld-person.read_address.read_person.read-extended_translation"}}},"FoaType":{"type":"string","enum":["empty","masculine","feminine","indefinite"]},"TranslationDTO.jsonld-person.read_address.read_person.read-extended_translation":{"type":"object","description":"","properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"language":{"type":"string","format":"iri-reference"},"content":{"type":"string"}}},"LegacyGenderSpecificFoaPart":{"type":"string","enum":["empty","male","female","none"],"deprecated":true,"description":"Will be removed use properties with FoaType instead."},"LegacyGenderType":{"type":"string","enum":["","m","f"],"deprecated":true,"description":"Will be removed use properties with FoaType instead."},"AccountType":{"type":"string","enum":["none","converia","sso"]},"AddressDTO.jsonld-person.read_address.read_person.read-extended_translation":{"type":"object","description":"","properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"id":{"description":"The unique identifier for the address","type":"integer"},"street":{"description":"The street","type":"string"},"zip":{"description":"The zip code","type":"string"},"city":{"description":"The city","type":"string"},"phone":{"description":"The phone number","type":"string"},"mobilePhone":{"description":"The mobile phone number","type":"string"},"fax":{"description":"The fax number","type":"string"},"company":{"description":"The company","type":"string"},"department":{"description":"The department","type":"string"},"aux":{"description":"The aux","type":"string"},"state":{"description":"The state","type":"string"},"country":{"description":"The country","type":"string"},"email":{"description":"The mail address","type":"string"},"careOf":{"description":"The careOf addition","type":"string"},"url":{"description":"The url","type":"string"},"vatId":{"description":"The vat","type":"string"}}},"Person.PersonDTO-person.read_address.read_person.read-extended_translation":{"type":"object","description":"Person","properties":{"id":{"description":"The unique identifier for the person entity","type":"integer"},"externalId":{"description":"The external ID used for referencing external accounts","type":"string"},"firstname":{"description":"The persons firstname","type":"string"},"lastname":{"description":"The persons surname","type":"string"},"foaType":{"$ref":"#/components/schemas/FoaType","description":"Foa type of the person","type":"string"},"academicPrefix":{"description":"The persons academic title","type":"string"},"academicSuffix":{"description":"The persons name suffix, additional information","type":"string"},"customSalutation":{"type":"array","items":{"$ref":"#/components/schemas/TranslationDTO-person.read_address.read_person.read-extended_translation"}},"genderspecificFormOfAddressPart":{"$ref":"#/components/schemas/LegacyGenderSpecificFoaPart","description":"The persons form of address","type":"string"},"birthday":{"description":"The persons birthday","type":"string","format":"date-time","nullable":true},"function":{"description":"The persons function / job / responsibility","type":"string"},"efn":{"description":"The persons unified training number","type":"string"},"lastUpdated":{"description":"Last change of the person or address infos","type":"string","format":"date-time"},"textVita":{"description":"Vita of a person","type":"string"},"gender":{"$ref":"#/components/schemas/LegacyGenderType","description":"Gender of the person, not stored in most cases","deprecated":true,"type":"string"},"memberId":{"description":"A global frame independet member id, not connected with the member management","type":"string"},"membership":{"description":"Institution the member id belongs to","type":"string"},"isMarkedDeleted":{"description":"Marker for deleted person","type":"boolean"},"isMarkedImported":{"description":"Marker for imported person","type":"boolean"},"additionalTextInfo":{"description":"Some additional plain text info","type":"string"},"accountType":{"$ref":"#/components/schemas/AccountType","description":"Type of account","type":"string"},"account":{"description":"The Account","type":"string","format":"iri-reference"},"mergedToPerson":{"description":"If person is merged, the link to the merge result","type":"string","format":"iri-reference","nullable":true},"language":{"description":"The persons language","type":"string","format":"iri-reference","nullable":true},"address":{"description":"The persons address","$ref":"#/components/schemas/AddressDTO-person.read_address.read_person.read-extended_translation"}}},"TranslationDTO-person.read_address.read_person.read-extended_translation":{"type":"object","description":"","properties":{"language":{"type":"string","format":"iri-reference"},"content":{"type":"string"}}},"AddressDTO-person.read_address.read_person.read-extended_translation":{"type":"object","description":"","properties":{"id":{"description":"The unique identifier for the address","type":"integer"},"street":{"description":"The street","type":"string"},"zip":{"description":"The zip code","type":"string"},"city":{"description":"The city","type":"string"},"phone":{"description":"The phone number","type":"string"},"mobilePhone":{"description":"The mobile phone number","type":"string"},"fax":{"description":"The fax number","type":"string"},"company":{"description":"The company","type":"string"},"department":{"description":"The department","type":"string"},"aux":{"description":"The aux","type":"string"},"state":{"description":"The state","type":"string"},"country":{"description":"The country","type":"string"},"email":{"description":"The mail address","type":"string"},"careOf":{"description":"The careOf addition","type":"string"},"url":{"description":"The url","type":"string"},"vatId":{"description":"The vat","type":"string"}}}}},"paths":{"/api/people":{"get":{"operationId":"getPersonCollection","tags":["Person"],"responses":{"200":{"description":"Person collection","content":{"application/ld+json":{"schema":{"type":"object","properties":{"hydra:member":{"type":"array","items":{"$ref":"#/components/schemas/Person.PersonDTO.jsonld-person.read_address.read_person.read-extended_translation"}},"hydra:totalItems":{"type":"integer","minimum":0},"hydra:view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"hydra:first":{"type":"string","format":"iri-reference"},"hydra:last":{"type":"string","format":"iri-reference"},"hydra:previous":{"type":"string","format":"iri-reference"},"hydra:next":{"type":"string","format":"iri-reference"}}},"hydra:search":{"type":"object","properties":{"@type":{"type":"string"},"hydra:template":{"type":"string"},"hydra:variableRepresentation":{"type":"string"},"hydra:mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":"string","nullable":true},"required":{"type":"boolean"}}}}}}},"required":["hydra:member"]}},"text/html":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Person.PersonDTO-person.read_address.read_person.read-extended_translation"}}}}}},"summary":"Retrieves the collection of Person resources.","description":"Retrieves the collection of Person resources.","parameters":[{"name":"changed[after]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"changed[before]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"id[between]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"id[gt]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"id[gte]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"id[lt]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"id[lte]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false}],"deprecated":false}}}}
```

## Retrieves a Person resource.

> Retrieves a Person resource.

```json
{"openapi":"3.0.0","info":{"title":"Converia API","version":"3.5.0"},"servers":[{"url":"/","description":""}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Person.PersonDTO.jsonld-person.read_address.read_person.read-extended_translation":{"type":"object","description":"Person","properties":{"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"id":{"description":"The unique identifier for the person entity","type":"integer"},"externalId":{"description":"The external ID used for referencing external accounts","type":"string"},"firstname":{"description":"The persons firstname","type":"string"},"lastname":{"description":"The persons surname","type":"string"},"foaType":{"$ref":"#/components/schemas/FoaType","description":"Foa type of the person","type":"string"},"academicPrefix":{"description":"The persons academic title","type":"string"},"academicSuffix":{"description":"The persons name suffix, additional information","type":"string"},"customSalutation":{"type":"array","items":{"$ref":"#/components/schemas/TranslationDTO.jsonld-person.read_address.read_person.read-extended_translation"}},"genderspecificFormOfAddressPart":{"$ref":"#/components/schemas/LegacyGenderSpecificFoaPart","description":"The persons form of address","type":"string"},"birthday":{"description":"The persons birthday","type":"string","format":"date-time","nullable":true},"function":{"description":"The persons function / job / responsibility","type":"string"},"efn":{"description":"The persons unified training number","type":"string"},"lastUpdated":{"description":"Last change of the person or address infos","type":"string","format":"date-time"},"textVita":{"description":"Vita of a person","type":"string"},"gender":{"$ref":"#/components/schemas/LegacyGenderType","description":"Gender of the person, not stored in most cases","deprecated":true,"type":"string"},"memberId":{"description":"A global frame independet member id, not connected with the member management","type":"string"},"membership":{"description":"Institution the member id belongs to","type":"string"},"isMarkedDeleted":{"description":"Marker for deleted person","type":"boolean"},"isMarkedImported":{"description":"Marker for imported person","type":"boolean"},"additionalTextInfo":{"description":"Some additional plain text info","type":"string"},"accountType":{"$ref":"#/components/schemas/AccountType","description":"Type of account","type":"string"},"account":{"description":"The Account","type":"string","format":"iri-reference"},"mergedToPerson":{"description":"If person is merged, the link to the merge result","type":"string","format":"iri-reference","nullable":true},"language":{"description":"The persons language","type":"string","format":"iri-reference","nullable":true},"address":{"description":"The persons address","$ref":"#/components/schemas/AddressDTO.jsonld-person.read_address.read_person.read-extended_translation"}}},"FoaType":{"type":"string","enum":["empty","masculine","feminine","indefinite"]},"TranslationDTO.jsonld-person.read_address.read_person.read-extended_translation":{"type":"object","description":"","properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"language":{"type":"string","format":"iri-reference"},"content":{"type":"string"}}},"LegacyGenderSpecificFoaPart":{"type":"string","enum":["empty","male","female","none"],"deprecated":true,"description":"Will be removed use properties with FoaType instead."},"LegacyGenderType":{"type":"string","enum":["","m","f"],"deprecated":true,"description":"Will be removed use properties with FoaType instead."},"AccountType":{"type":"string","enum":["none","converia","sso"]},"AddressDTO.jsonld-person.read_address.read_person.read-extended_translation":{"type":"object","description":"","properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"id":{"description":"The unique identifier for the address","type":"integer"},"street":{"description":"The street","type":"string"},"zip":{"description":"The zip code","type":"string"},"city":{"description":"The city","type":"string"},"phone":{"description":"The phone number","type":"string"},"mobilePhone":{"description":"The mobile phone number","type":"string"},"fax":{"description":"The fax number","type":"string"},"company":{"description":"The company","type":"string"},"department":{"description":"The department","type":"string"},"aux":{"description":"The aux","type":"string"},"state":{"description":"The state","type":"string"},"country":{"description":"The country","type":"string"},"email":{"description":"The mail address","type":"string"},"careOf":{"description":"The careOf addition","type":"string"},"url":{"description":"The url","type":"string"},"vatId":{"description":"The vat","type":"string"}}},"Person.PersonDTO-person.read_address.read_person.read-extended_translation":{"type":"object","description":"Person","properties":{"id":{"description":"The unique identifier for the person entity","type":"integer"},"externalId":{"description":"The external ID used for referencing external accounts","type":"string"},"firstname":{"description":"The persons firstname","type":"string"},"lastname":{"description":"The persons surname","type":"string"},"foaType":{"$ref":"#/components/schemas/FoaType","description":"Foa type of the person","type":"string"},"academicPrefix":{"description":"The persons academic title","type":"string"},"academicSuffix":{"description":"The persons name suffix, additional information","type":"string"},"customSalutation":{"type":"array","items":{"$ref":"#/components/schemas/TranslationDTO-person.read_address.read_person.read-extended_translation"}},"genderspecificFormOfAddressPart":{"$ref":"#/components/schemas/LegacyGenderSpecificFoaPart","description":"The persons form of address","type":"string"},"birthday":{"description":"The persons birthday","type":"string","format":"date-time","nullable":true},"function":{"description":"The persons function / job / responsibility","type":"string"},"efn":{"description":"The persons unified training number","type":"string"},"lastUpdated":{"description":"Last change of the person or address infos","type":"string","format":"date-time"},"textVita":{"description":"Vita of a person","type":"string"},"gender":{"$ref":"#/components/schemas/LegacyGenderType","description":"Gender of the person, not stored in most cases","deprecated":true,"type":"string"},"memberId":{"description":"A global frame independet member id, not connected with the member management","type":"string"},"membership":{"description":"Institution the member id belongs to","type":"string"},"isMarkedDeleted":{"description":"Marker for deleted person","type":"boolean"},"isMarkedImported":{"description":"Marker for imported person","type":"boolean"},"additionalTextInfo":{"description":"Some additional plain text info","type":"string"},"accountType":{"$ref":"#/components/schemas/AccountType","description":"Type of account","type":"string"},"account":{"description":"The Account","type":"string","format":"iri-reference"},"mergedToPerson":{"description":"If person is merged, the link to the merge result","type":"string","format":"iri-reference","nullable":true},"language":{"description":"The persons language","type":"string","format":"iri-reference","nullable":true},"address":{"description":"The persons address","$ref":"#/components/schemas/AddressDTO-person.read_address.read_person.read-extended_translation"}}},"TranslationDTO-person.read_address.read_person.read-extended_translation":{"type":"object","description":"","properties":{"language":{"type":"string","format":"iri-reference"},"content":{"type":"string"}}},"AddressDTO-person.read_address.read_person.read-extended_translation":{"type":"object","description":"","properties":{"id":{"description":"The unique identifier for the address","type":"integer"},"street":{"description":"The street","type":"string"},"zip":{"description":"The zip code","type":"string"},"city":{"description":"The city","type":"string"},"phone":{"description":"The phone number","type":"string"},"mobilePhone":{"description":"The mobile phone number","type":"string"},"fax":{"description":"The fax number","type":"string"},"company":{"description":"The company","type":"string"},"department":{"description":"The department","type":"string"},"aux":{"description":"The aux","type":"string"},"state":{"description":"The state","type":"string"},"country":{"description":"The country","type":"string"},"email":{"description":"The mail address","type":"string"},"careOf":{"description":"The careOf addition","type":"string"},"url":{"description":"The url","type":"string"},"vatId":{"description":"The vat","type":"string"}}}}},"paths":{"/api/people/{id}":{"get":{"operationId":"getPersonItem","tags":["Person"],"responses":{"200":{"description":"Person resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Person.PersonDTO.jsonld-person.read_address.read_person.read-extended_translation"}},"text/html":{"schema":{"$ref":"#/components/schemas/Person.PersonDTO-person.read_address.read_person.read-extended_translation"}}}},"404":{"description":"Resource not found"}},"summary":"Retrieves a Person resource.","description":"Retrieves a Person resource.","parameters":[{"name":"id","in":"path","description":"Resource identifier","required":true,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string"},"style":"simple","explode":false,"allowReserved":false}],"deprecated":false}}}}
```

## Retrieves a Person resource.

> Retrieves a Person resource.

```json
{"openapi":"3.0.0","info":{"title":"Converia API","version":"3.5.0"},"servers":[{"url":"/","description":""}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Person.PersonMergeHistoryDTO.jsonld-person.read_address.read_person.read-extended_translation":{"type":"object","description":"Person","properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"id":{"type":"integer"},"ancestorList":{"description":"List of ancestor person ids recursion is limit to 10 levels so","type":"array","items":{"type":"integer"}}}},"Person.PersonMergeHistoryDTO-person.read_address.read_person.read-extended_translation":{"type":"object","description":"Person","properties":{"id":{"type":"integer"},"ancestorList":{"description":"List of ancestor person ids recursion is limit to 10 levels so","type":"array","items":{"type":"integer"}}}}}},"paths":{"/api/people/{id}/merge-history":{"get":{"operationId":"get_merge_historyPersonItem","tags":["Person"],"responses":{"200":{"description":"Person resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Person.PersonMergeHistoryDTO.jsonld-person.read_address.read_person.read-extended_translation"}},"text/html":{"schema":{"$ref":"#/components/schemas/Person.PersonMergeHistoryDTO-person.read_address.read_person.read-extended_translation"}}}},"404":{"description":"Resource not found"}},"summary":"Retrieves a Person resource.","description":"Retrieves a Person resource.","parameters":[{"name":"id","in":"path","description":"Resource identifier","required":true,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string"},"style":"simple","explode":false,"allowReserved":false}],"deprecated":false}}}}
```