Person

Retrieves the collection of Person resources.

get

Retrieves the collection of Person resources.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

changed[after]stringOptional

changed[before]stringOptional

id[between]stringOptional

id[gt]stringOptional

id[gte]stringOptional

id[lt]stringOptional

id[lte]stringOptional

Responses

200

Person collection

application/ld+jsontext/html

get

/api/people

HTTPcURLJavaScriptPython

GET /api/people HTTP/1.1
Host: /
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-01-15T13:51:08.223Z",
      "function": "text",
      "efn": "text",
      "lastUpdated": "2026-01-15T13:51:08.223Z",
      "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.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Resource identifier

Responses

200

Person resource

application/ld+jsontext/html

404

Resource not found

get

/api/people/{id}

HTTPcURLJavaScriptPython

GET /api/people/{id} HTTP/1.1
Host: /
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-01-15T13:51:08.223Z",
  "function": "text",
  "efn": "text",
  "lastUpdated": "2026-01-15T13:51:08.223Z",
  "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.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Resource identifier

Responses

200

Person resource

application/ld+jsontext/html

404

Resource not found

get

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

HTTPcURLJavaScriptPython

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

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