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/3335/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+jsonBody
{
"data": {
"type": "people",
"attributes": {},
"relationships": {
"company": {
"data": {
"type": "companies",
"id": "2427"
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "1044"
}
},
"custom_role": {
"data": {
"type": "custom_roles",
"id": "3279"
}
}
}
}
}Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "3335",
"type": "people",
"attributes": {
"agent": false,
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2418@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": "2026-02-25T05:07:47.000+01:00",
"is_user": true,
"user_id": 3340,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2026-02-25T05:07:46.974+01: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": "2026-02-25T05:07:46.974+01: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": "884"
}
},
"company": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"manager": {
"meta": {
"included": false
}
},
"subsidiary": {
"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/3339/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+jsonBody
{
"data": {
"type": "people",
"attributes": {
"custom_role_id": 0
}
}
}Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"meta": {},
"source": {
"pointer": "data/attributes/company"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "is not accessible",
"meta": {},
"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+jsonHeaders
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "3340",
"type": "people",
"attributes": {
"agent": false,
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user3294@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": 3344,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2026-02-25T05:07:47.204+01: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": "887"
}
},
"company": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"manager": {
"meta": {
"included": false
}
},
"subsidiary": {
"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/3343
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+jsonHeaders
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "3343",
"type": "people",
"attributes": {
"agent": false,
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2421@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": "2026-02-25T05:07:47.371+01: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": "2026-02-25T05:07:47.371+01: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": "889"
}
},
"company": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"manager": {
"meta": {
"included": false
}
},
"subsidiary": {
"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+jsonBody
{
"data": {
"type": "people",
"attributes": {
"first_name": "test name"
}
}
}Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "3346",
"type": "people",
"attributes": {
"agent": false,
"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": "2026-02-25T05:07:47.530+01: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": "2026-02-25T05:07:47.530+01: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": "891"
}
},
"company": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"manager": {
"meta": {
"included": false
}
},
"subsidiary": {
"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+jsonBody
{
"data": {
"type": "people",
"attributes": {
"first_name": ""
}
}
}Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"meta": {},
"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/3352
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+jsonBody
{
"data": {
"type": "people",
"attributes": {
"first_name": "new name"
},
"relationships": {
"subscribers": {
"data": [
{
"type": "people",
"id": "3353"
},
{
"type": "people",
"id": "3354"
}
]
}
}
}
}Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "3352",
"type": "people",
"attributes": {
"agent": false,
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2422@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": "2026-02-25T05:07:47.767+01: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": "2026-02-25T05:07:47.767+01: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": "895"
}
},
"company": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"manager": {
"meta": {
"included": false
}
},
"subsidiary": {
"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
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+jsonBody
{
"data": {
"type": "people",
"attributes": {
"first_name": ""
}
}
}Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"meta": {},
"source": {
"pointer": "data/attributes/first_name"
}
}
]
}PATCH /api/v2/people/3476/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+jsonHeaders
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "3476",
"type": "people",
"attributes": {
"agent": false,
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user3418@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": "2026-02-25T05:07:54.000+01:00",
"is_user": true,
"user_id": 3468,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2026-02-25T05:07:54.127+01: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": "2026-02-25T05:07:54.128+01: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": "952"
}
},
"company": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"manager": {
"meta": {
"included": false
}
},
"subsidiary": {
"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/3480/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+jsonHeaders
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "3480",
"type": "people",
"attributes": {
"agent": false,
"avatar_url": null,
"contact": {},
"deactivated_at": "2026-02-25T05:07:54.000+01:00",
"email": "user3422@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": "2026-02-25T05:07:00.000+01:00",
"is_user": true,
"user_id": 3472,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2026-02-25T05:07:54.272+01: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": "2026-02-25T05:07:54.272+01: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": "954"
}
},
"company": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"manager": {
"meta": {
"included": false
}
},
"subsidiary": {
"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/3488/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+jsonHeaders
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "3488",
"type": "people",
"attributes": {
"agent": false,
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user3429@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": "2026-02-25T05:07:00.000+01:00",
"is_user": true,
"user_id": 3479,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2026-02-25T05:07:54.551+01: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": "2026-02-25T05:07:54.551+01: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": "958"
}
},
"company": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"manager": {
"meta": {
"included": false
}
},
"subsidiary": {
"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/3492/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+jsonHeaders
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "3492",
"type": "people",
"attributes": {
"agent": false,
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user3432@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": "2026-02-25T05:07:00.000+01:00",
"is_user": true,
"user_id": 3482,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2026-02-25T05:07:54.720+01: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": "2026-02-25T05:07:54.720+01: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": "960"
}
},
"company": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"manager": {
"meta": {
"included": false
}
},
"subsidiary": {
"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/3513/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+jsonHeaders
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "3513",
"type": "people",
"attributes": {
"agent": false,
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2511@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": "2026-02-25T05:07:55.000+01: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": "2026-02-25T05:07:55.742+01: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": "2026-02-25T05:07:55.742+01: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": "969"
}
},
"company": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"manager": {
"meta": {
"included": false
}
},
"subsidiary": {
"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/3517/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+jsonHeaders
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "3517",
"type": "people",
"attributes": {
"agent": false,
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2513@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": "2026-02-25T05:07:55.000+01: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": "2026-02-25T05:07:55.887+01: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": "2026-02-25T05:07:55.887+01: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": "971"
}
},
"company": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"manager": {
"meta": {
"included": false
}
},
"subsidiary": {
"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/3519/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+jsonHeaders
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "3519",
"type": "people",
"attributes": {
"agent": false,
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2514@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": "2026-02-25T05:07:56.000+01: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": "2026-02-25T05:07:55.959+01: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": "2026-02-25T05:07:55.959+01: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": "972"
}
},
"company": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"manager": {
"meta": {
"included": false
}
},
"subsidiary": {
"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/3526/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+jsonHeaders
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "3526",
"type": "people",
"attributes": {
"agent": false,
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2518@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": "2026-02-25T05:07:56.283+01: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": "2026-02-25T05:07:56.283+01: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": "975"
}
},
"company": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"manager": {
"meta": {
"included": false
}
},
"subsidiary": {
"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/3528/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+jsonHeaders
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "409",
"code": "not_archived",
"title": "Conflict error",
"meta": {},
"source": {}
}
]
}PATCH /api/v2/people/3532/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+jsonHeaders
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "3532",
"type": "people",
"attributes": {
"agent": false,
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2521@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": "2026-02-25T05:07:56.475+01: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": "2026-02-25T05:07:56.475+01: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": "978"
}
},
"company": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"manager": {
"meta": {
"included": false
}
},
"subsidiary": {
"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/3535/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+jsonHeaders
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "403",
"code": "email_duplicate",
"title": "Access Denied",
"detail": "Email has already been taken",
"meta": {},
"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+jsonBody
{
"winner_id": 3537,
"loser_id": 3538
}Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "3537",
"type": "people",
"attributes": {
"agent": false,
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2522@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": "2026-02-25T05:07:56.608+01: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": "2026-02-25T05:07:56.608+01: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": "980"
}
},
"company": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"manager": {
"meta": {
"included": false
}
},
"subsidiary": {
"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/3550/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+jsonHeaders
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "3550",
"type": "people",
"attributes": {
"agent": false,
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user3473@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": 3523,
"tag_list": [],
"virtual": true,
"custom_fields": null,
"created_at": "2026-02-25T05:07:56.926+01: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": "2026-02-25T05:07:56.926+01: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": "984"
}
},
"company": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"manager": {
"meta": {
"included": false
}
},
"subsidiary": {
"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/3556/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+jsonBody
{
"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 25 Feb 2026