API Documentation

API Endpoint

People

People

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

Supported sort params

  • email

Filter operations are supported on this endpoint.

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": "2835",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 1,
        "email": "user2815@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": "2024-04-19T06:07:15.000+02:00",
        "last_seen_at": "2024-04-19T06:07:15.042+02:00",
        "archived_at": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 2861,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-04-19T06:07:14.992+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
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "794"
          }
        },
        "manager": {
          "meta": {
            "included": false
          }
        },
        "company": {
          "meta": {
            "included": false
          }
        },
        "subsidiary": {
          "meta": {
            "included": false
          }
        },
        "holiday_calendar": {
          "meta": {
            "included": false
          }
        },
        "custom_role": {
          "meta": {
            "included": false
          }
        },
        "teams": {
          "meta": {
            "included": false
          }
        },
        "custom_field_people": {
          "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/2838

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": "2838",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "deactivated_at": null,
      "first_name": "name",
      "last_name": "surname",
      "nickname": null,
      "role_id": null,
      "email": "person2024@email.com",
      "title": null,
      "contact": {},
      "status_emoji": null,
      "status_expires_at": null,
      "status_text": null,
      "joined_at": null,
      "last_seen_at": null,
      "archived_at": null,
      "invited_at": null,
      "is_user": false,
      "user_id": null,
      "tag_list": [],
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2024-04-19T06:07:15.256+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": "2024-04-19T06:07:15.256+02:00",
      "two_factor_auth": null,
      "availabilities": "[]",
      "external_id": null,
      "external_sync": false,
      "hrm_type_id": 2
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "796"
        }
      },
      "manager": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "holiday_calendar": {
        "meta": {
          "included": false
        }
      },
      "custom_role": {
        "meta": {
          "included": false
        }
      },
      "teams": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "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": "2841",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "deactivated_at": null,
      "first_name": "test name",
      "last_name": null,
      "nickname": null,
      "role_id": null,
      "email": null,
      "title": null,
      "contact": null,
      "status_emoji": null,
      "status_expires_at": null,
      "status_text": null,
      "joined_at": null,
      "last_seen_at": null,
      "archived_at": null,
      "invited_at": null,
      "is_user": false,
      "user_id": null,
      "tag_list": [],
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2024-04-19T06:07:15.530+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": "2024-04-19T06:07:15.530+02:00",
      "two_factor_auth": null,
      "availabilities": "[]",
      "external_id": null,
      "external_sync": false,
      "hrm_type_id": 2
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "798"
        }
      },
      "manager": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "holiday_calendar": {
        "meta": {
          "included": false
        }
      },
      "custom_role": {
        "meta": {
          "included": false
        }
      },
      "teams": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "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/2845

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": "2846"
          },
          {
            "type": "people",
            "id": "2847"
          }
        ]
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "2845",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "deactivated_at": null,
      "first_name": "new name",
      "last_name": "surname",
      "nickname": null,
      "role_id": null,
      "email": "person2025@email.com",
      "title": null,
      "contact": {},
      "status_emoji": null,
      "status_expires_at": null,
      "status_text": null,
      "joined_at": null,
      "last_seen_at": null,
      "archived_at": null,
      "invited_at": null,
      "is_user": false,
      "user_id": null,
      "tag_list": [
        "junior",
        "remote"
      ],
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2024-04-19T06:07:15.856+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": "2024-04-19T06:07:15.856+02:00",
      "two_factor_auth": null,
      "availabilities": "[]",
      "external_id": null,
      "external_sync": false,
      "hrm_type_id": 2
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "801"
        }
      },
      "manager": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "holiday_calendar": {
        "meta": {
          "included": false
        }
      },
      "custom_role": {
        "meta": {
          "included": false
        }
      },
      "teams": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/people/2849

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/2853

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": "2853",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "deactivated_at": null,
      "first_name": "new name",
      "last_name": "surname",
      "nickname": null,
      "role_id": null,
      "email": "person2030@email.com",
      "title": null,
      "contact": {},
      "status_emoji": null,
      "status_expires_at": null,
      "status_text": null,
      "joined_at": null,
      "last_seen_at": null,
      "archived_at": null,
      "invited_at": null,
      "is_user": false,
      "user_id": null,
      "tag_list": [],
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2024-04-19T06:07:16.427+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": "2024-04-19T06:07:16.427+02:00",
      "two_factor_auth": null,
      "availabilities": "[]",
      "external_id": "123",
      "external_sync": false,
      "hrm_type_id": 2
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "804"
        }
      },
      "manager": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "holiday_calendar": {
        "meta": {
          "included": false
        }
      },
      "custom_role": {
        "meta": {
          "included": false
        }
      },
      "teams": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/people/2855

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": "2855",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "deactivated_at": null,
      "first_name": "name",
      "last_name": "surname",
      "nickname": null,
      "role_id": null,
      "email": "person2031@email.com",
      "title": null,
      "contact": {},
      "status_emoji": null,
      "status_expires_at": null,
      "status_text": null,
      "joined_at": null,
      "last_seen_at": null,
      "archived_at": null,
      "invited_at": null,
      "is_user": false,
      "user_id": null,
      "tag_list": [
        "junior",
        "remote"
      ],
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2024-04-19T06:07:16.591+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": "2024-04-19T06:07:16.591+02:00",
      "two_factor_auth": null,
      "availabilities": "[]",
      "external_id": "123",
      "external_sync": true,
      "hrm_type_id": 2
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "805"
        }
      },
      "manager": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "holiday_calendar": {
        "meta": {
          "included": false
        }
      },
      "custom_role": {
        "meta": {
          "included": false
        }
      },
      "teams": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "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/invite
Requestssets user and sends invitationreturns error

PATCH  /api/v2/people/2961/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": {
      "first_name": "test name",
      "role_id": "3"
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "2209"
        }
      },
      "subsidiary": {
        "data": {
          "type": "subsidiaries",
          "id": "217"
        }
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "2961",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "deactivated_at": null,
      "first_name": "test name",
      "last_name": "surname",
      "nickname": null,
      "role_id": 3,
      "email": "invite@email.com",
      "title": null,
      "contact": {},
      "status_emoji": null,
      "status_expires_at": null,
      "status_text": null,
      "joined_at": null,
      "last_seen_at": null,
      "archived_at": null,
      "invited_at": "2024-04-19T06:07:27.000+02:00",
      "is_user": true,
      "user_id": 2978,
      "tag_list": [],
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2024-04-19T06:07:27.857+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": "2024-04-19T06:07:27.857+02:00",
      "two_factor_auth": false,
      "availabilities": "[]",
      "external_id": null,
      "external_sync": false,
      "hrm_type_id": 1
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "855"
        }
      },
      "manager": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "holiday_calendar": {
        "meta": {
          "included": false
        }
      },
      "custom_role": {
        "meta": {
          "included": false
        }
      },
      "teams": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/people/2963/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": 3169
    }
  }
}
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": "can't be blank",
      "source": {
        "pointer": "data/attributes/role_id"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/subsidiary"
      }
    }
  ]
}

Invite a person
PATCH/api/v2/people/{id}/invite

URI Parameters
HideShow
id
number (required) Example: 1

person id

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

PATCH  /api/v2/people/2991/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": "2991",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "deactivated_at": null,
      "first_name": "name",
      "last_name": "surname",
      "nickname": null,
      "role_id": 3,
      "email": "user2949@email.com",
      "title": null,
      "contact": {},
      "status_emoji": null,
      "status_expires_at": null,
      "status_text": null,
      "joined_at": null,
      "last_seen_at": null,
      "archived_at": null,
      "invited_at": "2024-04-19T06:07:31.000+02:00",
      "is_user": true,
      "user_id": 3006,
      "tag_list": [],
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2024-04-19T06:07:31.007+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": "2024-04-19T06:07:31.007+02:00",
      "two_factor_auth": false,
      "availabilities": "[]",
      "external_id": null,
      "external_sync": false,
      "hrm_type_id": 1
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "870"
        }
      },
      "manager": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "holiday_calendar": {
        "meta": {
          "included": false
        }
      },
      "custom_role": {
        "meta": {
          "included": false
        }
      },
      "teams": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "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/2995/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": "2995",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "deactivated_at": "2024-04-19T06:07:31.000+02:00",
      "first_name": "name",
      "last_name": "surname",
      "nickname": null,
      "role_id": 3,
      "email": "user2953@email.com",
      "title": null,
      "contact": {},
      "status_emoji": null,
      "status_expires_at": null,
      "status_text": null,
      "joined_at": null,
      "last_seen_at": null,
      "archived_at": null,
      "invited_at": "2024-04-19T06:07:31.000+02:00",
      "is_user": true,
      "user_id": 3010,
      "tag_list": [],
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2024-04-19T06:07:31.362+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": "2024-04-19T06:07:31.362+02:00",
      "two_factor_auth": false,
      "availabilities": "[]",
      "external_id": null,
      "external_sync": false,
      "hrm_type_id": 1
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "872"
        }
      },
      "manager": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "holiday_calendar": {
        "meta": {
          "included": false
        }
      },
      "custom_role": {
        "meta": {
          "included": false
        }
      },
      "teams": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "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/3003/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": "3003",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "deactivated_at": null,
      "first_name": "name",
      "last_name": "surname",
      "nickname": null,
      "role_id": 3,
      "email": "user2960@email.com",
      "title": null,
      "contact": {},
      "status_emoji": null,
      "status_expires_at": null,
      "status_text": null,
      "joined_at": null,
      "last_seen_at": null,
      "archived_at": null,
      "invited_at": "2024-04-19T06:07:31.000+02:00",
      "is_user": true,
      "user_id": 3017,
      "tag_list": [],
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2024-04-19T06:07:31.987+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": "2024-04-19T06:07:31.987+02:00",
      "two_factor_auth": false,
      "availabilities": "[]",
      "external_id": null,
      "external_sync": false,
      "hrm_type_id": 1
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "876"
        }
      },
      "manager": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "holiday_calendar": {
        "meta": {
          "included": false
        }
      },
      "custom_role": {
        "meta": {
          "included": false
        }
      },
      "teams": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/people/3007/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": "3007",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "deactivated_at": null,
      "first_name": "name",
      "last_name": "surname",
      "nickname": null,
      "role_id": 3,
      "email": "user2963@email.com",
      "title": null,
      "contact": {},
      "status_emoji": null,
      "status_expires_at": null,
      "status_text": null,
      "joined_at": null,
      "last_seen_at": null,
      "archived_at": null,
      "invited_at": "2024-04-19T06:07:32.000+02:00",
      "is_user": true,
      "user_id": 3020,
      "tag_list": [],
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2024-04-19T06:07:32.302+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": "2024-04-19T06:07:32.302+02:00",
      "two_factor_auth": false,
      "availabilities": "[]",
      "external_id": null,
      "external_sync": false,
      "hrm_type_id": 1
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "878"
        }
      },
      "manager": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "holiday_calendar": {
        "meta": {
          "included": false
        }
      },
      "custom_role": {
        "meta": {
          "included": false
        }
      },
      "teams": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "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/3025/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": "3025",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "deactivated_at": null,
      "first_name": "name",
      "last_name": "surname",
      "nickname": null,
      "role_id": null,
      "email": "person2109@email.com",
      "title": null,
      "contact": {},
      "status_emoji": null,
      "status_expires_at": null,
      "status_text": null,
      "joined_at": null,
      "last_seen_at": null,
      "archived_at": "2024-04-19T06:07:34.000+02:00",
      "invited_at": null,
      "is_user": false,
      "user_id": null,
      "tag_list": [],
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2024-04-19T06:07:34.276+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": "2024-04-19T06:07:34.276+02:00",
      "two_factor_auth": null,
      "availabilities": "[]",
      "external_id": null,
      "external_sync": false,
      "hrm_type_id": 2
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "887"
        }
      },
      "manager": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "holiday_calendar": {
        "meta": {
          "included": false
        }
      },
      "custom_role": {
        "meta": {
          "included": false
        }
      },
      "teams": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/people/3027/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": "3027",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "deactivated_at": null,
      "first_name": "name",
      "last_name": "surname",
      "nickname": null,
      "role_id": null,
      "email": "person2110@email.com",
      "title": null,
      "contact": {},
      "status_emoji": null,
      "status_expires_at": null,
      "status_text": null,
      "joined_at": null,
      "last_seen_at": null,
      "archived_at": "2024-04-19T06:07:34.000+02:00",
      "invited_at": null,
      "is_user": false,
      "user_id": null,
      "tag_list": [],
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2024-04-19T06:07:34.427+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": "2024-04-19T06:07:34.427+02:00",
      "two_factor_auth": null,
      "availabilities": "[]",
      "external_id": null,
      "external_sync": false,
      "hrm_type_id": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "888"
        }
      },
      "manager": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "holiday_calendar": {
        "meta": {
          "included": false
        }
      },
      "custom_role": {
        "meta": {
          "included": false
        }
      },
      "teams": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/people/3029/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": "3029",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "deactivated_at": null,
      "first_name": "name",
      "last_name": "surname",
      "nickname": null,
      "role_id": null,
      "email": "person2111@email.com",
      "title": null,
      "contact": {},
      "status_emoji": null,
      "status_expires_at": null,
      "status_text": null,
      "joined_at": null,
      "last_seen_at": null,
      "archived_at": "2024-04-19T06:07:34.000+02:00",
      "invited_at": null,
      "is_user": false,
      "user_id": null,
      "tag_list": [],
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2024-04-19T06:07:34.565+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": "2024-04-19T06:07:34.565+02:00",
      "two_factor_auth": null,
      "availabilities": "[]",
      "external_id": null,
      "external_sync": false,
      "hrm_type_id": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "889"
        }
      },
      "manager": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "holiday_calendar": {
        "meta": {
          "included": false
        }
      },
      "custom_role": {
        "meta": {
          "included": false
        }
      },
      "teams": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "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/3036/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": "3036",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "deactivated_at": null,
      "first_name": "name",
      "last_name": "surname",
      "nickname": null,
      "role_id": null,
      "email": "person2115@email.com",
      "title": null,
      "contact": {},
      "status_emoji": null,
      "status_expires_at": null,
      "status_text": null,
      "joined_at": null,
      "last_seen_at": null,
      "archived_at": null,
      "invited_at": null,
      "is_user": false,
      "user_id": null,
      "tag_list": [],
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2024-04-19T06:07:35.287+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": "2024-04-19T06:07:35.287+02:00",
      "two_factor_auth": null,
      "availabilities": "[]",
      "external_id": null,
      "external_sync": false,
      "hrm_type_id": 2
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "892"
        }
      },
      "manager": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "holiday_calendar": {
        "meta": {
          "included": false
        }
      },
      "custom_role": {
        "meta": {
          "included": false
        }
      },
      "teams": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/people/3038/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": "not_archived",
      "title": "Access Denied",
      "detail": "You are not authorized to access this resource",
      "source": {}
    }
  ]
}

PATCH  /api/v2/people/3042/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": "3042",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "deactivated_at": null,
      "first_name": "name",
      "last_name": "surname",
      "nickname": null,
      "role_id": null,
      "email": "person2118@email.com",
      "title": null,
      "contact": {},
      "status_emoji": null,
      "status_expires_at": null,
      "status_text": null,
      "joined_at": null,
      "last_seen_at": null,
      "archived_at": null,
      "invited_at": null,
      "is_user": false,
      "user_id": null,
      "tag_list": [],
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2024-04-19T06:07:35.669+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": "2024-04-19T06:07:35.669+02:00",
      "two_factor_auth": null,
      "availabilities": "[]",
      "external_id": null,
      "external_sync": false,
      "hrm_type_id": 2
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "895"
        }
      },
      "manager": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "holiday_calendar": {
        "meta": {
          "included": false
        }
      },
      "custom_role": {
        "meta": {
          "included": false
        }
      },
      "teams": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/people/3045/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": 3047,
  "loser_id": 3048
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "3047",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "deactivated_at": null,
      "first_name": "name",
      "last_name": "surname",
      "nickname": null,
      "role_id": null,
      "email": "person2119@email.com",
      "title": null,
      "contact": {},
      "status_emoji": null,
      "status_expires_at": null,
      "status_text": null,
      "joined_at": null,
      "last_seen_at": null,
      "archived_at": null,
      "invited_at": null,
      "is_user": false,
      "user_id": null,
      "tag_list": [],
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2024-04-19T06:07:36.013+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": "2024-04-19T06:07:36.013+02:00",
      "two_factor_auth": null,
      "availabilities": "[]",
      "external_id": null,
      "external_sync": false,
      "hrm_type_id": 2
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "897"
        }
      },
      "manager": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "holiday_calendar": {
        "meta": {
          "included": false
        }
      },
      "custom_role": {
        "meta": {
          "included": false
        }
      },
      "teams": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "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/3060/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": "3060",
    "type": "people",
    "attributes": {
      "avatar_url": null,
      "deactivated_at": null,
      "first_name": "name",
      "last_name": "surname",
      "nickname": null,
      "role_id": 3,
      "email": "user3000@email.com",
      "title": null,
      "contact": {},
      "status_emoji": null,
      "status_expires_at": null,
      "status_text": null,
      "joined_at": null,
      "last_seen_at": null,
      "archived_at": null,
      "invited_at": null,
      "is_user": true,
      "user_id": 3057,
      "tag_list": [],
      "virtual": true,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2024-04-19T06:07:36.787+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": "2024-04-19T06:07:36.787+02:00",
      "two_factor_auth": false,
      "availabilities": "[]",
      "external_id": null,
      "external_sync": false,
      "hrm_type_id": 1
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "901"
        }
      },
      "manager": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "holiday_calendar": {
        "meta": {
          "included": false
        }
      },
      "custom_role": {
        "meta": {
          "included": false
        }
      },
      "teams": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "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/3066/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 19 Apr 2024