List persons

GET 
/api/persons

Required permissions:

• settings.team: allows view of company persons.

Here the dedicated support page.

Request

Query Parameters

job_title_id integer

Possible values: >= 1

Filter items by the job_title_id field.

allocation_manager_id integer

Possible values: >= 1

Filter items by the allocation_manager_id field.

limit integer

Possible values: >= 1 and <= 100

Default value: 100

The number of items to include in the response.

offset integer

Default value: 0

The offset of the first returned item.

updated_at date-time

Filter items by the updated_at field.

Operators:

Equal

Usage: eq:{value}

Not equal

Usage: neq:{value}

Greater than

Usage: gt:{value}

Greater than or equal

Usage: gte:{value}

Less than

Usage: lt:{value}

Less than or equal

Usage: lte:{value}

In list

Usage: in:{value_1},{value_2},{value_3}

Not in list

Usage: nin:{value_1},{value_2},{value_3}

Between

Description: The given values are inclusive.

Usage: bt:{value_min},{value_max}

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 list of persons.

application/json

Schema

Schema

• Array [

id integerrequired

Possible values: >= 1

The unique identifier of the resource

created_at date-timerequired

The date and time when the resource was created

updated_at date-timerequired

The date and time when the resource was last updated

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_id integerrequired

Possible values: >= 1

ID of the role associated with this person

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 associated with this person

stream_id integerrequired

Possible values: >= 1

ID of the stream associated with this person.

⚠️ Ignored if Streams are disabled in company settings.

price_list_id integerrequired

Possible values: >= 1

ID of the price list associated with this person

job_title_id integer

Possible values: >= 1

ID of the job title associated with this person

allocation_manager_id integer

Possible values: >= 1

ID of the allocation manager associated with this person

capacity_id integerrequired

Possible values: >= 1

ID of the capacity associated with this person

location_id integerrequired

Possible values: >= 1

ID of the location associated with this person

• ]

Example (from schema)

[
  {
    "id": 1,
    "created_at": "2026-03-24T16:47:31.922Z",
    "updated_at": "2026-03-24T16:47:31.922Z",
    "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
  }
]

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"
}

412

Precondition failed

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

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

Loading...