Get a person

GET 
/api/persons/:id

Required permissions:

• settings.team: allows view of company persons.

Here the dedicated support page.

Request

Path Parameters

id integerrequired

The ID of the employee to view

Header Parameters

Wethod-Company stringrequired

The company you want to interact with

Wethod-Version stringrequired

The API version you want to use

Responses

200

Returns the requested person.

application/json

Schema

Schema

id integerrequired

Possible values: >= 1

created_at date-timerequired
updated_at date-timerequired
email stringrequired

Possible values: <= 50 characters

The person email

name stringrequired

Possible values: <= 50 characters

The person name

surname stringrequired

Possible values: <= 50 characters

The person surname

role stringrequired

Possible values: <= 50 characters

The person role

is_archived booleanrequired

Whether the person is archived

is_visible_in_people_allocation booleanrequired

Whether the person is visible in people allocation

has_timesheet_required booleanrequired

Whether the person needs to fill in timesheet

level_id integerrequired

Possible values: >= 1

ID of the level to associate with this person

price_list_id integerrequired

Possible values: >= 1

ID of the price list to associate with this person

job_title_id integer

Possible values: >= 1

ID of the job title to associate with this person

allocation_manager_id integer

Possible values: >= 1

ID of the allocation manager to associate with this person

Example (from schema)

{
  "id": 1,
  "created_at": "2025-04-22T10:10:02.489Z",
  "updated_at": "2025-04-22T10:10:02.489Z",
  "email": "john.doe@example.com",
  "name": "John",
  "surname": "Doe",
  "role": "ROLE_USER",
  "is_archived": false,
  "is_visible_in_people_allocation": true,
  "has_timesheet_required": true,
  "level_id": 1,
  "price_list_id": 1,
  "job_title_id": 1,
  "allocation_manager_id": 1
}

400

Validation failed

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

failures

object[]

List of validation errors

Array [

field string

Name of the field causing the error

message string

Human-readable description of the error

]

Example (from schema)

{
  "key": "invalid_data",
  "message": "You provided invalid data. Check 'failures' for details.",
  "failures": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

403

Forbidden

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

404

Not found

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "not_found",
  "message": "string"
}

Loading...