Get the authenticated person
GET/api/persons/me
Returns the person data associated with the currently authenticated user. No specific permissions are required beyond authentication.
Request
Header Parameters
The company you want to interact with
The API version you want to use
Responses
- 200
- 401
- 412
Returns the authenticated person.
- application/json
- Schema
- Example (from schema)
Schema
Possible values: >= 1
The unique identifier of the resource
The date and time when the resource was created
The date and time when the resource was last updated
Possible values: <= 50 characters
The person email
Possible values: <= 50 characters
The person name
Possible values: <= 50 characters
The person surname
Possible values: >= 1
ID of the role associated with this person
Possible values: <= 50 characters
The person role
Whether the person is archived
Whether the person is visible in people allocation
Whether the person needs to fill in timesheet
Possible values: >= 1
ID of the level associated with this person
Possible values: >= 1
ID of the stream associated with this person.
⚠️ Ignored if Streams are disabled in company settings.
Possible values: >= 1
ID of the price list associated with this person
Possible values: >= 1
ID of the job title associated with this person
Possible values: >= 1
ID of the allocation manager associated with this person
Possible values: >= 1
ID of the capacity associated with this person
Possible values: >= 1
ID of the location associated with this person
{
"id": 1,
"created_at": "2026-03-04T11:57:16.715Z",
"updated_at": "2026-03-04T11:57:16.715Z",
"email": "john.doe@example.com",
"name": "John",
"surname": "Doe",
"role_id": 1,
"role": "super user",
"is_archived": false,
"is_visible_in_people_allocation": true,
"has_timesheet_required": true,
"level_id": 1,
"stream_id": 1,
"price_list_id": 1,
"job_title_id": 1,
"allocation_manager_id": 1,
"capacity_id": 1,
"location_id": 1
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
Error unique key
Human-readable message describing the error
{
"key": "string",
"message": "string"
}
Precondition failed
- application/json
- Schema
- Example (from schema)
Schema
Error unique key
Human-readable message describing the error
{
"key": "precondition_failure",
"message": "string"
}