Get person

GET /data/persons/{instance_id}
Jwt authorization

Retrieve a person by their ID and return it as a JSON object. Supports including relations. Managers see safe serialization, others see minimal information.

Path parameters

  • instance_id string(uuid) Required

Query parameters

  • relations boolean

    Whether to include relations

Responses

  • 200 application/json

    Person retrieved successfully

    Hide response attributes Show response attributes object
    • id string(uuid)
    • first_name string
    • last_name string
    • email string(email)
    • role string
    • active boolean
    • contract_type string
    • two_factor_authentication string
    • departments array[string(uuid)]
    • created_at string(date-time)
    • updated_at string(date-time)
  • 400

    Invalid ID format or query error

GET /data/persons/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "role": "user",
  "active": true,
  "contract_type": "permanent",
  "two_factor_authentication": "none",
  "departments": [
    "string"
  ],
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}