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
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/3250/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": "2417"
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "912"
}
},
"custom_role": {
"data": {
"type": "custom_roles",
"id": "3194"
}
}
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3250",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2347@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-07-22T06:06:13.000+02:00",
"is_user": true,
"user_id": 3253,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-07-22T06:06:13.650+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-07-22T06:06:13.650+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": "863"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"time_tracking_policy": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3254/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": "3255",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user3208@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": 3257,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-07-22T06:06:13.840+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": "866"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"time_tracking_policy": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"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/3258
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": "3258",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2350@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-07-22T06:06:13.984+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-07-22T06:06:13.984+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": "868"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"time_tracking_policy": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"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": "3261",
"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-07-22T06:06:14.110+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-07-22T06:06:14.110+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": "870"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"time_tracking_policy": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"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/3265
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": "3266"
},
{
"type": "people",
"id": "3267"
}
]
}
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3265",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2351@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-07-22T06:06:14.245+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-07-22T06:06:14.245+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": "873"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"time_tracking_policy": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3269
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/3273
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": "3273",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2356@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-07-22T06:06:14.457+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-07-22T06:06:14.457+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": "876"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"time_tracking_policy": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3275
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": "3275",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2357@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-07-22T06:06:14.523+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-07-22T06:06:14.523+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": "877"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"time_tracking_policy": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3385/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": "3385",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user3328@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-07-22T06:06:19.000+02:00",
"is_user": true,
"user_id": 3377,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-07-22T06:06:19.267+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-07-22T06:06:19.267+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": "929"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"time_tracking_policy": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"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/3389/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": "3389",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": "2025-07-22T06:06:19.000+02:00",
"email": "user3332@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-07-22T06:06:00.000+02:00",
"is_user": true,
"user_id": 3381,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-07-22T06:06:19.379+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-07-22T06:06:19.379+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": "931"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"time_tracking_policy": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"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/3397/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": "3397",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user3339@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-07-22T06:06:00.000+02:00",
"is_user": true,
"user_id": 3388,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-07-22T06:06:19.659+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-07-22T06:06:19.659+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": "935"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"time_tracking_policy": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3401/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": "3401",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user3342@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-07-22T06:06:00.000+02:00",
"is_user": true,
"user_id": 3391,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"created_at": "2025-07-22T06:06:19.782+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-07-22T06:06:19.782+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": "937"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"time_tracking_policy": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"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/3422/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": "3422",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2437@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-07-22T06:06:20.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-07-22T06:06:20.512+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-07-22T06:06:20.512+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": "946"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"time_tracking_policy": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3424/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": "3424",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2438@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-07-22T06:06:20.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-07-22T06:06:20.579+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-07-22T06:06:20.579+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": "947"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"time_tracking_policy": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3426/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": "3426",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2439@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-07-22T06:06:20.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-07-22T06:06:20.640+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-07-22T06:06:20.640+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": "948"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"time_tracking_policy": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"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/3433/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": "3433",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2443@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-07-22T06:06:20.907+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-07-22T06:06:20.907+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": "951"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"time_tracking_policy": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3435/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/3439/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": "3439",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2446@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-07-22T06:06:21.056+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-07-22T06:06:21.056+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": "954"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"time_tracking_policy": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3442/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": 3444,
"loser_id": 3445
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3444",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "person2447@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-07-22T06:06:21.156+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-07-22T06:06:21.156+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": "956"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"time_tracking_policy": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/people/3457/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": "3457",
"type": "people",
"attributes": {
"avatar_url": null,
"contact": {},
"deactivated_at": null,
"email": "user3382@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": 3431,
"tag_list": [],
"virtual": true,
"custom_fields": null,
"created_at": "2025-07-22T06:06:21.413+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-07-22T06:06:21.413+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": "960"
}
},
"manager": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"custom_role": {
"meta": {
"included": false
}
},
"time_tracking_policy": {
"meta": {
"included": false
}
},
"approval_policy_assignment": {
"meta": {
"included": false
}
},
"teams": {
"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/3463/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 22 Jul 2025