API Documentation

API Endpoint

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/invite
Requestssets user and sends invitationreturns error

PATCH  /api/v2/people/3176/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": "2366"
        }
      },
      "subsidiary": {
        "data": {
          "type": "subsidiaries",
          "id": "912"
        }
      },
      "custom_role": {
        "data": {
          "type": "custom_roles",
          "id": "3120"
        }
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "3176",
    "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-08-02T02:08:38.000+02:00",
      "is_user": true,
      "user_id": 3179,
      "tag_list": [],
      "virtual": false,
      "custom_fields": null,
      "created_at": "2025-08-02T02:08:38.121+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-08-02T02:08:38.121+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": "837"
        }
      },
      "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
        }
      },
      "service_types": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/people/3180/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
    }
  }
}
Responses422
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 person
PATCH/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.

URI Parameters
HideShow
company_id
number (required) Example: 1

company id

custom_role_id
number (required) Example: 1

role id

subsidiary_id
number (optional) Example: 1

subsidiary id

GET /api/v2/people
Requestsreturns people

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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "3181",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "contact": {},
        "deactivated_at": null,
        "email": "user3134@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": 3183,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "created_at": "2025-08-02T02:08:38.364+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": "840"
          }
        },
        "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
          }
        },
        "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 people
GET/api/v2/people

GET /api/v2/people/1
Requestsreturns person

GET  /api/v2/people/3184

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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "3184",
    "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-08-02T02:08:38.546+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-08-02T02:08:38.546+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": "842"
        }
      },
      "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
        }
      },
      "service_types": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Get a person
GET/api/v2/people/{id}

URI Parameters
HideShow
id
number (required) Example: 1

person id

POST /api/v2/people
Requestscreates personreturns error

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"
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "3187",
    "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-08-02T02:08:38.704+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-08-02T02:08:38.704+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
        }
      },
      "time_tracking_policy": {
        "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": ""
    }
  }
}
Responses422
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 person
POST/api/v2/people

URI Parameters
HideShow
first_name: `John` (string, required) - first_name
string (required) 
PATCH /api/v2/people/1
Requestsupdates personreturns errorupdates personupdates person

PATCH  /api/v2/people/3191

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": "3192"
          },
          {
            "type": "people",
            "id": "3193"
          }
        ]
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "3191",
    "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-08-02T02:08:38.895+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-08-02T02:08:38.896+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
        }
      },
      "time_tracking_policy": {
        "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/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": ""
    }
  }
}
Responses422
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/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"
    }
  }
}
Responses200
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": "person2308@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-08-02T02:08:39.188+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-08-02T02:08:39.188+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": "850"
        }
      },
      "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
        }
      },
      "service_types": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/people/3201

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"
      ]
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "3201",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "contact": {},
      "deactivated_at": null,
      "email": "person2309@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-08-02T02:08:39.274+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-08-02T02:08:39.274+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": "851"
        }
      },
      "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
        }
      },
      "service_types": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Update a person
PATCH/api/v2/people/{id}

URI Parameters
HideShow
id
number (required) Example: 1

person id

PATCH /api/v2/people/1/resend
Requestsresend invitation mail

PATCH  /api/v2/people/3311/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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "3311",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "contact": {},
      "deactivated_at": null,
      "email": "user3254@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-08-02T02:08:45.000+02:00",
      "is_user": true,
      "user_id": 3303,
      "tag_list": [],
      "virtual": false,
      "custom_fields": null,
      "created_at": "2025-08-02T02:08:45.194+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-08-02T02:08:45.194+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": "903"
        }
      },
      "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
        }
      },
      "service_types": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Resend email to a person
PATCH/api/v2/people/{id}/resend

URI Parameters
HideShow
id
number (required) Example: 1

person id

PATCH /api/v2/people/1/deactivate
Requestsdeactivates person

PATCH  /api/v2/people/3315/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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "3315",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "contact": {},
      "deactivated_at": "2025-08-02T02:08:45.000+02:00",
      "email": "user3258@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-08-02T02:08:00.000+02:00",
      "is_user": true,
      "user_id": 3307,
      "tag_list": [],
      "virtual": false,
      "custom_fields": null,
      "created_at": "2025-08-02T02:08:45.349+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-08-02T02:08:45.349+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": "905"
        }
      },
      "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
        }
      },
      "service_types": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Deactivate a person
PATCH/api/v2/people/{id}/deactivate

URI Parameters
HideShow
id
number (required) Example: 1

person id

PATCH /api/v2/people/1/activate
Requestsactivates useractivates user

PATCH  /api/v2/people/3323/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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "3323",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "contact": {},
      "deactivated_at": null,
      "email": "user3265@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-08-02T02:08:00.000+02:00",
      "is_user": true,
      "user_id": 3314,
      "tag_list": [],
      "virtual": false,
      "custom_fields": null,
      "created_at": "2025-08-02T02:08:45.672+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-08-02T02:08:45.672+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
        }
      },
      "time_tracking_policy": {
        "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/3327/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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "3327",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "contact": {},
      "deactivated_at": null,
      "email": "user3268@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-08-02T02:08:00.000+02:00",
      "is_user": true,
      "user_id": 3317,
      "tag_list": [],
      "virtual": false,
      "custom_fields": null,
      "created_at": "2025-08-02T02:08:45.839+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-08-02T02:08:45.839+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": "911"
        }
      },
      "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
        }
      },
      "service_types": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Activate a person
PATCH/api/v2/people/{id}/activate

URI Parameters
HideShow
id
number (required) Example: 1

person id

PATCH /api/v2/people/1/archive
Requestsarchives personarchives persondeletes bookings and engagements

PATCH  /api/v2/people/3348/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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "3348",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "contact": {},
      "deactivated_at": null,
      "email": "person2389@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-08-02T02:08:46.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-08-02T02:08:46.867+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-08-02T02:08:46.867+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": "920"
        }
      },
      "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
        }
      },
      "service_types": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/people/3350/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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "3350",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "contact": {},
      "deactivated_at": null,
      "email": "person2390@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-08-02T02:08:46.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-08-02T02:08:46.940+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-08-02T02:08:46.940+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": "921"
        }
      },
      "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
        }
      },
      "service_types": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/people/3352/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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "3352",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "contact": {},
      "deactivated_at": null,
      "email": "person2391@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-08-02T02:08:47.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-08-02T02:08:47.018+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-08-02T02:08:47.018+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": "922"
        }
      },
      "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
        }
      },
      "service_types": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Archive a person
PATCH/api/v2/people/{id}/archive

URI Parameters
HideShow
id
number (required) Example: 1

person id

PATCH /api/v2/people/1/restore
Requestsrestores personreturns errorrestores personrestores person

PATCH  /api/v2/people/3359/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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "3359",
    "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": 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-08-02T02:08:47.363+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-08-02T02:08:47.363+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
        }
      },
      "time_tracking_policy": {
        "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/3361/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
Responses409
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/3365/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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "3365",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "contact": {},
      "deactivated_at": null,
      "email": "person2398@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-08-02T02:08:47.590+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-08-02T02:08:47.590+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": "928"
        }
      },
      "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
        }
      },
      "service_types": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/people/3368/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
Responses403
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 person
PATCH/api/v2/people/{id}/restore

URI Parameters
HideShow
id
number (required) Example: 1

person id

PATCH /api/v2/people/merge
Requestsmerges person

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": 3370,
  "loser_id": 3371
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "3370",
    "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-08-02T02:08:47.747+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-08-02T02:08:47.747+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
        }
      },
      "time_tracking_policy": {
        "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": {}
}

Merge a person
PATCH/api/v2/people/merge

URI Parameters
HideShow
id
number (required) Example: 1

person id

PATCH /api/v2/people/1/virtualize
Requestsvirtualizes person

PATCH  /api/v2/people/3383/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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "3383",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "contact": {},
      "deactivated_at": null,
      "email": "user3308@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": 3357,
      "tag_list": [],
      "virtual": true,
      "custom_fields": null,
      "created_at": "2025-08-02T02:08:48.128+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-08-02T02:08:48.128+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": "934"
        }
      },
      "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
        }
      },
      "service_types": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Virtualize a person
PATCH/api/v2/people/{id}/virtualize

URI Parameters
HideShow
id
number (required) Example: 1

person id

PATCH /api/v2/people/1/regenerate_recovery_codes
Requestsgenerates new 2FA codes

PATCH  /api/v2/people/3389/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"
    }
  }
}
Responses204
This response has no content.

Regenerate 2FA recovery codes
PATCH/api/v2/people/{id}/regenerate_recovery_codes

URI Parameters
HideShow
id
number (required) Example: 1

person id

Generated by aglio on 02 Aug 2025