Skip to main content

Users

Admin permissions required, except when retrieving the currently authenticated user.

Retrieve the currently authenticated user

Retrieves the currently authenticated user. Returns a user object and a 200 OK response code.

Link to documentation

hrvst users me
OptionDescriptionRequired
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse

List all users

Returns a list of your users. The users are returned sorted by creation date, with the most recently created users appearing first.

The response contains an object with a users property that contains an array of up to per_page users. Each entry in the array is a separate user object. If no more users are available, the resulting array will be empty. Several additional pagination properties are included in the response to simplify paginating your users.

Link to documentation

hrvst users list
OptionDescriptionRequired
--is_activePass true to only return active users and false to return inactive users.false
--updated_sinceOnly return users that have been updated since the given date and time.false
--pageThe page number to use in pagination. Use all to retrieve all pages.false
--per_pageThe number of records to return per page. Can range between 1 and 100.false
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse

Retrieve a specific user

Retrieves the user with the given ID. Returns a user object and a 200 OK response code if a valid identifier was provided.

Link to documentation

hrvst users get
OptionDescriptionRequired
--user_idThe ID of the user you're retrieving.true
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse

Create a user

Creates a new user object. Returns a user object and a 201 Created response code if the call succeeded.

Link to documentation

hrvst users create
OptionDescriptionRequired
--first_nameThe first name of the user.true
--last_nameThe last name of the user.true
--emailThe email address of the user.true
--telephoneThe telephone number for the user.false
--timezoneThe user’s timezone. Defaults to the company’s timezone.false
--has_access_to_all_future_projectsWhether the user should be automatically added to future projects.false
--is_contractorWhether the user is a contractor or an employee.false
--is_adminWhether the user has admin permissions.false
--is_project_managerWhether the user has project manager permissions. Defaults to false.false
--can_see_ratesWhether the user can see billable rates on projects. Only applicable to project managers.false
--can_create_projectsWhether the user can create projects. Only applicable to project managers.false
--can_create_invoicesWhether the user can create invoices. Only applicable to project managers.false
--is_activeWhether the user is active or archived.false
--weekly_capacityThe number of hours per week this person is available to work in seconds.false
--default_hourly_rateThe billable rate to use for this user when they are added to a project.false
--cost_rateThe cost rate to use for this user when calculating a project’s costs vs billable amount.false
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse

Update a user

Updates the specific user by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Returns a user object and a 200 OK response code if the call succeeded.

Link to documentation

hrvst users update
OptionDescriptionRequired
--user_idThe ID of the user you're updating.true
--first_nameThe first name of the user.false
--last_nameThe last name of the user.false
--emailThe email address of the user.false
--telephoneThe telephone number for the user.false
--timezoneThe user’s timezone. Defaults to the company’s timezone.false
--has_access_to_all_future_projectsWhether the user should be automatically added to future projects.false
--is_contractorWhether the user is a contractor or an employee.false
--is_adminWhether the user has admin permissions.false
--is_project_managerWhether the user has project manager permissions. Defaults to false.false
--can_see_ratesWhether the user can see billable rates on projects. Only applicable to project managers.false
--can_create_projectsWhether the user can create projects. Only applicable to project managers.false
--can_create_invoicesWhether the user can create invoices. Only applicable to project managers.false
--is_activeWhether the user is active or archived.false
--weekly_capacityThe number of hours per week this person is available to work in seconds.false
--default_hourly_rateThe billable rate to use for this user when they are added to a project.false
--cost_rateThe cost rate to use for this user when calculating a project’s costs vs billable amount.false
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse

Delete a user

Delete a user. Deleting a user is only possible if they have no time entries or expenses associated with them. Returns a 200 OK response code if the call succeeded.

Link to documentation

hrvst users delete
OptionDescriptionRequired
--user_idThe ID of the user you're deleting.true
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse