API Documentation
People ¶
People ¶
For more details on how to work with custom fields please refer to Working with custom fields guide.
Supported filter params
-
id
-
email
-
status (1: active, 2: deactivated)
-
person_type (1: user, 2: contact, 3: placeholder)
-
role_id (array)
-
company_id (array)
-
tags
-
query
-
subscribable_type (task, deal, person, company, invoice, page)
-
subscribable_id (array)
-
custom_fields[id] (where id is the identifier of your custom field; for dropdown and multiselect custom fields, use array filter)
-
last_activity_at
-
two_factor_auth
-
team
-
autotracking
-
custom_role_id
-
manager_id
-
project_id
-
timesheet_submission_disabled (boolean)
-
time_tracking_policy_id
-
service_type_id
Supported sort params
-
name
-
email
-
title
-
last_seen_at
-
joined_at
-
role_id
-
autotracking
-
company_name
-
custom_role
-
custom_fields
-
two_factor_auth
-
schedulable
-
manager
Filter operations are supported on this endpoint.
PATCH /api/v2/people/3178/invite
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "people",
"attributes": {},
"relationships": {
"company": {
"data": {
"type": "companies",
"id": "2368"
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "912"
}
},
"custom_role": {
"data": {
"type": "custom_roles",
"id": "3122"
}
}
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3178",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2299@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": 1,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": "2025-09-03T06:07:04.000+02:00",
"is_user": true,
"user_id": 3181,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-09-03T06:07:04.478+02:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-09-03T06:07:04.478+02:00",
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 1,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "839"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"service_types": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3182/invite
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "people",
"attributes": {
"custom_role_id": 0
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/company"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "is not accessible",
"source": {
"pointer": "data/attributes/custom_role"
}
}
]
}
Invite a personPATCH/api/v2/people/invite
Action used to invite contacts into your Productive organization. By doing so, the contact can accept that invitation and then become a user.
- company_id
number
(required) Example: 1company id
- custom_role_id
number
(required) Example: 1role id
- subsidiary_id
number
(optional) Example: 1subsidiary id
GET /api/v2/people
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": [
{
"id": "3183",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user3136@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": 1,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": null,
"is_user": true,
"user_id": 3185,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-09-03T06:07:04.734+02:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": null,
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 1,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "842"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"service_types": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
}
],
"links": {
"first": "http://api-test.productive.io/api/v2/people?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://api-test.productive.io/api/v2/people?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200
}
}
Get peopleGET/api/v2/people
GET /api/v2/people/3186
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3186",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2302@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": null,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": null,
"is_user": false,
"user_id": null,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-09-03T06:07:04.916+02:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-09-03T06:07:04.916+02:00",
"two_factor_auth": null,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 2,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "844"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"service_types": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/people
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "people",
"attributes": {
"first_name": "test name"
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3189",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": null,
"deactivated_at": null,
"email": null,
"first_name": "test name",
"last_name": null,
"nickname": null,
"original_avatar_url": null,
"role_id": null,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": null,
"is_user": false,
"user_id": null,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-09-03T06:07:05.090+02:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-09-03T06:07:05.090+02:00",
"two_factor_auth": null,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 2,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "846"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"service_types": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/people
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "people",
"attributes": {
"first_name": "test name"
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3191",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": null,
"deactivated_at": null,
"email": null,
"first_name": "test name",
"last_name": null,
"nickname": null,
"original_avatar_url": null,
"role_id": null,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": null,
"is_user": false,
"user_id": null,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-09-03T06:07:05.166+02:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-09-03T06:07:05.166+02:00",
"two_factor_auth": null,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 2,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "847"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"service_types": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/people
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "people",
"attributes": {
"first_name": ""
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/first_name"
}
}
]
}
Create a personPOST/api/v2/people
- first_name: `John` (string, required) - first_name
string
(required)
PATCH /api/v2/people/3195
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "people",
"attributes": {
"first_name": "new name",
"tag_list": [
"junior",
"remote"
]
},
"relationships": {
"subscribers": {
"data": [
{
"type": "people",
"id": "3196"
},
{
"type": "people",
"id": "3197"
}
]
}
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3195",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2303@email.com",
"first_name": "new name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": null,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": null,
"is_user": false,
"user_id": null,
"tag_list": [
"junior",
"remote"
],
"virtual": false,
"custom_fields": null,
"created_at": "2025-09-03T06:07:05.382+02:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-09-03T06:07:05.382+02:00",
"two_factor_auth": null,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 2,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "850"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"service_types": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3199
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "people",
"attributes": {
"first_name": "new name",
"tag_list": [
"junior",
"remote"
]
},
"relationships": {
"subscribers": {
"data": [
{
"type": "people",
"id": "3200"
},
{
"type": "people",
"id": "3201"
}
]
}
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3199",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2306@email.com",
"first_name": "new name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": null,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": null,
"is_user": false,
"user_id": null,
"tag_list": [
"junior",
"remote"
],
"virtual": false,
"custom_fields": null,
"created_at": "2025-09-03T06:07:05.520+02:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-09-03T06:07:05.520+02:00",
"two_factor_auth": null,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 2,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "851"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"service_types": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3203
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "people",
"attributes": {
"first_name": ""
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/first_name"
}
}
]
}
PATCH /api/v2/people/3207
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "people",
"attributes": {
"first_name": "new name"
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3207",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2311@email.com",
"first_name": "new name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": null,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": null,
"is_user": false,
"user_id": null,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-09-03T06:07:05.819+02:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-09-03T06:07:05.819+02:00",
"two_factor_auth": null,
"availabilities": "[]",
"external_id": "123",
"external_sync": false,
"hrm_type_id": 2,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "854"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"service_types": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3209
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "people",
"attributes": {
"tag_list": [
"junior",
"remote"
]
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3209",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2312@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": null,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": null,
"is_user": false,
"user_id": null,
"tag_list": [
"junior",
"remote"
],
"virtual": false,
"custom_fields": null,
"created_at": "2025-09-03T06:07:05.905+02:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-09-03T06:07:05.905+02:00",
"two_factor_auth": null,
"availabilities": "[]",
"external_id": "123",
"external_sync": true,
"hrm_type_id": 2,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "855"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"service_types": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3319/resend
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3319",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user3260@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": 3,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": "2025-09-03T06:07:12.000+02:00",
"is_user": true,
"user_id": 3309,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-09-03T06:07:12.004+02:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-09-03T06:07:12.005+02:00",
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 1,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "907"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"service_types": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Resend email to a personPATCH/api/v2/people/{id}/resend
- id
number
(required) Example: 1person id
PATCH /api/v2/people/3323/deactivate
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3323",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": "2025-09-03T06:07:12.000+02:00",
"email": "user3264@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": 3,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": "2025-09-03T06:07:00.000+02:00",
"is_user": true,
"user_id": 3313,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-09-03T06:07:12.179+02:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-09-03T06:07:12.179+02:00",
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 1,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "909"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"service_types": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Deactivate a personPATCH/api/v2/people/{id}/deactivate
- id
number
(required) Example: 1person id
PATCH /api/v2/people/3331/activate
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3331",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user3271@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": 3,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": "2025-09-03T06:07:00.000+02:00",
"is_user": true,
"user_id": 3320,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-09-03T06:07:12.504+02:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-09-03T06:07:12.504+02:00",
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 1,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "913"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"service_types": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3335/activate
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3335",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user3274@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": 3,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": "2025-09-03T06:07:00.000+02:00",
"is_user": true,
"user_id": 3323,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-09-03T06:07:12.656+02:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-09-03T06:07:12.656+02:00",
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 1,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "915"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"service_types": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Activate a personPATCH/api/v2/people/{id}/activate
- id
number
(required) Example: 1person id
PATCH /api/v2/people/3356/archive
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3356",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2392@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": null,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": "2025-09-03T06:07:13.000+02:00",
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": null,
"is_user": false,
"user_id": null,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-09-03T06:07:13.658+02:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-09-03T06:07:13.658+02:00",
"two_factor_auth": null,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 2,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "924"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"service_types": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3358/archive
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3358",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2393@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": null,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": "2025-09-03T06:07:13.000+02:00",
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": null,
"is_user": false,
"user_id": null,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-09-03T06:07:13.730+02:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-09-03T06:07:13.730+02:00",
"two_factor_auth": null,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 2,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "925"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"service_types": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3360/archive
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3360",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2394@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": null,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": "2025-09-03T06:07:13.000+02:00",
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": null,
"is_user": false,
"user_id": null,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-09-03T06:07:13.800+02:00",
"placeholder": true,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-09-03T06:07:13.800+02:00",
"two_factor_auth": null,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": null,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "926"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"service_types": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3362/archive
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3362",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2395@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": null,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": "2025-09-03T06:07:13.000+02:00",
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": null,
"is_user": false,
"user_id": null,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-09-03T06:07:13.877+02:00",
"placeholder": true,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-09-03T06:07:13.877+02:00",
"two_factor_auth": null,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": null,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "927"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"service_types": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Archive a personPATCH/api/v2/people/{id}/archive
- id
number
(required) Example: 1person id
PATCH /api/v2/people/3369/restore
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3369",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2399@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": null,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": null,
"is_user": false,
"user_id": null,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-09-03T06:07:14.223+02:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-09-03T06:07:14.223+02:00",
"two_factor_auth": null,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 2,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "930"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"service_types": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3371/restore
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "409",
"code": "not_archived",
"title": "Conflict error",
"source": {}
}
]
}
PATCH /api/v2/people/3375/restore
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3375",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2402@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": null,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": null,
"is_user": false,
"user_id": null,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-09-03T06:07:14.442+02:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-09-03T06:07:14.442+02:00",
"two_factor_auth": null,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 2,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "933"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"service_types": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3378/restore
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "403",
"code": "email_duplicate",
"title": "Access Denied",
"detail": "Email has already been taken",
"source": {}
}
]
}
Restore a personPATCH/api/v2/people/{id}/restore
- id
number
(required) Example: 1person id
PATCH /api/v2/people/merge
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"winner_id": 3380,
"loser_id": 3381
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3380",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2403@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": null,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": null,
"is_user": false,
"user_id": null,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-09-03T06:07:14.582+02:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-09-03T06:07:14.582+02:00",
"two_factor_auth": null,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 2,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "935"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"service_types": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3393/virtualize
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3393",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user3315@email.com",
"first_name": "name",
"last_name": "surname",
"nickname": null,
"original_avatar_url": null,
"role_id": 3,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"time_off_status_sync": true,
"title": null,
"archived_at": null,
"autotracking": false,
"joined_at": null,
"last_seen_at": null,
"invited_at": null,
"is_user": true,
"user_id": 3364,
"tag_list": [],
"virtual": true,
"custom_fields": null,
"created_at": "2025-09-03T06:07:14.939+02:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": "2025-09-03T06:07:14.939+02:00",
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false,
"hrm_type_id": 1,
"champion": false,
"timesheet_submission_disabled": false,
"offboarding_status": "not_initiated",
"offboarding_id": null,
"time_tracking_policy_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "939"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"service_types": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Virtualize a personPATCH/api/v2/people/{id}/virtualize
- id
number
(required) Example: 1person id
PATCH /api/v2/people/3399/regenerate_recovery_codes
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "people",
"attributes": {
"password": "test_password"
}
}
}
Regenerate 2FA recovery codesPATCH/api/v2/people/{id}/regenerate_recovery_codes
- id
number
(required) Example: 1person id
Generated by aglio on 03 Sep 2025