Person

Retrieves the collection of Person resources.

get

Retrieves the collection of Person resources.

Autorisierungen

bearerAuth

AuthorizationstringErforderlich

Bearer authentication header of the form Bearer <token>.

Abfrageparameter

changed[after]stringOptional

changed[before]stringOptional

id[between]stringOptional

id[gt]stringOptional

id[gte]stringOptional

id[lt]stringOptional

id[lte]stringOptional

Antworten

200

Person collection

application/ld+jsontext/html

hydra:totalItemsintegerOptional

get

/api/people

HTTPcURLJavaScriptPython

GET /api/people HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Person collection

{
  "hydra:member": [
    {
      "@id": "text",
      "@type": "text",
      "@context": "text",
      "id": 1,
      "externalId": "text",
      "firstname": "text",
      "lastname": "text",
      "foaType": "empty",
      "academicPrefix": "text",
      "academicSuffix": "text",
      "customSalutation": [
        {
          "@context": "text",
          "@id": "text",
          "@type": "text",
          "language": "/entitiy/1",
          "content": "text"
        }
      ],
      "birthday": "2026-03-05T00:03:47.742Z",
      "function": "text",
      "efn": "text",
      "lastUpdated": "2026-03-05T00:03:47.742Z",
      "textVita": "text",
      "memberId": "text",
      "membership": "text",
      "isMarkedDeleted": true,
      "isMarkedImported": true,
      "additionalTextInfo": "text",
      "accountType": "none",
      "account": "/entitiy/1",
      "mergedToPerson": "/entitiy/1",
      "language": "/entitiy/1",
      "address": {
        "@context": "text",
        "@id": "text",
        "@type": "text",
        "id": 1,
        "street": "text",
        "zip": "text",
        "city": "text",
        "phone": "text",
        "mobilePhone": "text",
        "fax": "text",
        "company": "text",
        "department": "text",
        "aux": "text",
        "state": "text",
        "country": "text",
        "email": "text",
        "careOf": "text",
        "url": "text",
        "vatId": "text"
      }
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "string",
    "type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:search": {
    "@type": "text",
    "hydra:template": "text",
    "hydra:variableRepresentation": "text",
    "hydra:mapping": [
      {
        "@type": "text",
        "variable": "text",
        "property": "text",
        "required": true
      }
    ]
  }
}

Retrieves a Person resource.

get

Retrieves a Person resource.

Autorisierungen

bearerAuth

AuthorizationstringErforderlich

Bearer authentication header of the form Bearer <token>.

Pfadparameter

idstringErforderlich

Resource identifier

Antworten

200

Person resource

application/ld+jsontext/html

Person

@idstringNur lesenOptional

@typestringNur lesenOptional

@contextone ofNur lesenOptional

stringOptional

oder

idintegerOptional

The unique identifier for the person entity

externalIdstringOptional

The external ID used for referencing external accounts

firstnamestringOptional

The persons firstname

lastnamestringOptional

The persons surname

foaTypestring · enumOptional

Foa type of the person

Mögliche Werte:

academicPrefixstringOptional

The persons academic title

academicSuffixstringOptional

The persons name suffix, additional information

genderspecificFormOfAddressPartstring · enumOptionalVeraltet

The persons form of address

Mögliche Werte:

birthdaystring · date-time · nullfähigOptional

The persons birthday

functionstringOptional

The persons function / job / responsibility

efnstringOptional

The persons unified training number

lastUpdatedstring · date-timeOptional

Last change of the person or address infos

textVitastringOptional

Vita of a person

genderstring · enumOptionalVeraltet

Gender of the person, not stored in most cases

Mögliche Werte:

memberIdstringOptional

A global frame independet member id, not connected with the member management

membershipstringOptional

Institution the member id belongs to

isMarkedDeletedbooleanOptional

Marker for deleted person

isMarkedImportedbooleanOptional

Marker for imported person

additionalTextInfostringOptional

Some additional plain text info

accountTypestring · enumOptional

Type of account

Mögliche Werte:

accountstring · iri-referenceOptional

The Account

mergedToPersonstring · iri-reference · nullfähigOptional

If person is merged, the link to the merge result

languagestring · iri-reference · nullfähigOptional

The persons language

404

Resource not found

get

/api/people/{id}

HTTPcURLJavaScriptPython

GET /api/people/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "@id": "text",
  "@type": "text",
  "@context": "text",
  "id": 1,
  "externalId": "text",
  "firstname": "text",
  "lastname": "text",
  "foaType": "empty",
  "academicPrefix": "text",
  "academicSuffix": "text",
  "customSalutation": [
    {
      "@context": "text",
      "@id": "text",
      "@type": "text",
      "language": "/entitiy/1",
      "content": "text"
    }
  ],
  "birthday": "2026-03-05T00:03:47.742Z",
  "function": "text",
  "efn": "text",
  "lastUpdated": "2026-03-05T00:03:47.742Z",
  "textVita": "text",
  "memberId": "text",
  "membership": "text",
  "isMarkedDeleted": true,
  "isMarkedImported": true,
  "additionalTextInfo": "text",
  "accountType": "none",
  "account": "/entitiy/1",
  "mergedToPerson": "/entitiy/1",
  "language": "/entitiy/1",
  "address": {
    "@context": "text",
    "@id": "text",
    "@type": "text",
    "id": 1,
    "street": "text",
    "zip": "text",
    "city": "text",
    "phone": "text",
    "mobilePhone": "text",
    "fax": "text",
    "company": "text",
    "department": "text",
    "aux": "text",
    "state": "text",
    "country": "text",
    "email": "text",
    "careOf": "text",
    "url": "text",
    "vatId": "text"
  }
}

Retrieves a Person resource.

get

Retrieves a Person resource.

Autorisierungen

bearerAuth

AuthorizationstringErforderlich

Bearer authentication header of the form Bearer <token>.

Pfadparameter

idstringErforderlich

Resource identifier

Antworten

200

Person resource

application/ld+jsontext/html

Person

@contextone ofNur lesenOptional

stringOptional

oder

@idstringNur lesenOptional

@typestringNur lesenOptional

idintegerOptional

ancestorListinteger[]Optional

List of ancestor person ids recursion is limit to 10 levels so

404

Resource not found

get

/api/people/{id}/merge-history

HTTPcURLJavaScriptPython

GET /api/people/{id}/merge-history HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "id": 1,
  "ancestorList": [
    1
  ]
}