Skip to main content
Server path: /harvest-people | Type: Application | PCID required: Yes

Tools

ToolDescription
harvest_people_create_billable_rateCreate a billable rate
harvest_people_create_clientCreate a client
harvest_people_create_contactCreate a contact
harvest_people_create_cost_rateCreate a cost rate
harvest_people_create_roleCreate a role
harvest_people_create_userCreate a user
harvest_people_delete_clientDelete a client
harvest_people_delete_contactDelete a contact
harvest_people_delete_roleDelete a role
harvest_people_delete_userDelete a user
harvest_people_list_active_project_assignmentsList active project assignments
harvest_people_list_active_project_assignments_for_the_currently_authenticated_userList active project assignments for the currently authenticated user
harvest_people_list_assigned_teammates_for_specific_userList all assigned teammates for a specific user
harvest_people_list_billable_rates_for_specific_userList all billable rates for a specific user
harvest_people_list_clientsList all clients
harvest_people_list_contactsList all contacts
harvest_people_list_cost_rates_for_specific_userList all cost rates for a specific user
harvest_people_list_rolesList all roles
harvest_people_list_usersList all users
harvest_people_retrieve_billable_rateRetrieve a billable rate
harvest_people_retrieve_clientRetrieve a client
harvest_people_retrieve_companyRetrieve a company
harvest_people_retrieve_contactRetrieve a contact
harvest_people_retrieve_cost_rateRetrieve a cost rate
harvest_people_retrieve_roleRetrieve a role
harvest_people_retrieve_the_currently_authenticated_userRetrieve the currently authenticated user
harvest_people_retrieve_userRetrieve a user
harvest_people_update_clientUpdate a client
harvest_people_update_companyUpdate a company
harvest_people_update_contactUpdate a contact
harvest_people_update_roleUpdate a role
harvest_people_update_userUpdate a user
harvest_people_update_user_assigned_teammatesUpdate a user’s assigned teammates

harvest_people_create_billable_rate

Create a billable rate Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser Id
amountnumberYesThe amount of the billable rate.
start_datestringNoThe date the billable rate is effective. Cannot be a date in the future.

harvest_people_create_client

Create a client Parameters:
ParameterTypeRequiredDefaultDescription
addressstringNoA textual representation of the client’s physical address. May include new line characters.
currencystringNoThe currency used by the client. If not provided, the company’s currency will be used. See a list of supported currencies
is_activebooleanNoWhether the client is active, or archived. Defaults to true.
namestringYesA textual description of the client.

harvest_people_create_contact

Create a contact Parameters:
ParameterTypeRequiredDefaultDescription
client_idintegerYesThe ID of the client associated with this contact.
emailstringNoThe contact’s email address.
faxstringNoThe contact’s fax number.
first_namestringYesThe first name of the contact.
invoice_recipient_statusstringNoThe contact’s default role on the client’s invoices (Invoice email default in the web UI). One of none, recipient, cc, or bcc. Defaults to none.
last_namestringNoThe last name of the contact.
phone_mobilestringNoThe contact’s mobile phone number.
phone_officestringNoThe contact’s office phone number.
titlestringNoThe title of the contact.

harvest_people_create_cost_rate

Create a cost rate Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser Id
amountnumberYesThe amount of the cost rate.
start_datestringNoThe date the cost rate is effective. Cannot be a date in the future.

harvest_people_create_role

Create a role Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesThe name of the role.
user_idsinteger[]NoThe IDs of the users assigned to this role.

harvest_people_create_user

Create a user Parameters:
ParameterTypeRequiredDefaultDescription
access_rolesstring[]NoAccess role(s) that determine the user’s permissions in Harvest. Possible values: administrator, manager or member. Users with the manager role can additionally be granted one or more of these roles: project_creator, billable_rates_manager, managed_projects_invoice_drafter, managed_projects_invoice_manager, client_and_task_manager, time_and_expenses_manager, estimates_manager.
cost_ratenumberNoThe cost rate to use for this user when calculating a project’s costs vs billable amount. Defaults to 0.
default_hourly_ratenumberNoThe billable rate to use for this user when they are added to a project. Defaults to 0.
emailstringYesThe email address of the user.
first_namestringYesThe first name of the user.
has_access_to_all_future_projectsbooleanNoWhether the user should be automatically added to future projects. Defaults to false.
is_activebooleanNoWhether the user is active or archived. Defaults to true.
is_contractorbooleanNoWhether the user is a contractor or an employee. Defaults to false.
last_namestringYesThe last name of the user.
rolesstring[]NoDescriptive names of the business roles assigned to this person. They can be used for filtering reports, and have no effect in their permissions in Harvest.
timezonestringNoThe user’s timezone. Defaults to the company’s timezone. See a list of supported time zones.
weekly_capacityintegerNoThe number of hours per week this person is available to work in seconds. Defaults to 126000 seconds (35 hours).

harvest_people_delete_client

Delete a client Parameters:
ParameterTypeRequiredDefaultDescription
clientIdstringYesClient Id

harvest_people_delete_contact

Delete a contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesContact Id

harvest_people_delete_role

Delete a role Parameters:
ParameterTypeRequiredDefaultDescription
roleIdstringYesRole Id

harvest_people_delete_user

Delete a user Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser Id

harvest_people_list_active_project_assignments

List active project assignments Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser Id
updated_sincestringNoOnly return project assignments that have been updated since the given date and time.
pageintegerNoDEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)
cursorstringNoPagination cursor
per_pageintegerNoThe number of records to return per page. Can range between 1 and 2000. (Default: 2000)

harvest_people_list_active_project_assignments_for_the_currently_authenticated_user

List active project assignments for the currently authenticated user Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoThe page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)
per_pageintegerNoThe number of records to return per page. Can range between 1 and 2000. (Default: 2000)

harvest_people_list_assigned_teammates_for_specific_user

List all assigned teammates for a specific user Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser Id
pageintegerNoDEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 100 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)
cursorstringNoPagination cursor
per_pageintegerNoThe number of records to return per page. Can range between 1 and 2000. (Default: 2000)

harvest_people_list_billable_rates_for_specific_user

List all billable rates for a specific user Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser Id
pageintegerNoDEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)
cursorstringNoPagination cursor
per_pageintegerNoThe number of records to return per page. Can range between 1 and 2000. (Default: 2000)

harvest_people_list_clients

List all clients Parameters:
ParameterTypeRequiredDefaultDescription
is_activebooleanNoPass true to only return active clients and false to return inactive clients.
updated_sincestringNoOnly return clients that have been updated since the given date and time.
pageintegerNoDEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)
cursorstringNoPagination cursor
per_pageintegerNoThe number of records to return per page. Can range between 1 and 2000. (Default: 2000)

harvest_people_list_contacts

List all contacts Parameters:
ParameterTypeRequiredDefaultDescription
client_idintegerNoOnly return contacts belonging to the client with the given ID.
updated_sincestringNoOnly return contacts that have been updated since the given date and time.
pageintegerNoDEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)
cursorstringNoPagination cursor
per_pageintegerNoThe number of records to return per page. Can range between 1 and 2000. (Default: 2000)

harvest_people_list_cost_rates_for_specific_user

List all cost rates for a specific user Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser Id
pageintegerNoDEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)
cursorstringNoPagination cursor
per_pageintegerNoThe number of records to return per page. Can range between 1 and 2000. (Default: 2000)

harvest_people_list_roles

List all roles Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoDEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)
cursorstringNoPagination cursor
per_pageintegerNoThe number of records to return per page. Can range between 1 and 2000. (Default: 2000)

harvest_people_list_users

List all users Parameters:
ParameterTypeRequiredDefaultDescription
is_activebooleanNoPass true to only return active users and false to return inactive users.
updated_sincestringNoOnly return users that have been updated since the given date and time.
pageintegerNoDEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)
cursorstringNoPagination cursor
per_pageintegerNoThe number of records to return per page. Can range between 1 and 2000. (Default: 2000)

harvest_people_retrieve_billable_rate

Retrieve a billable rate Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser Id
billableRateIdstringYesBillable Rate Id

harvest_people_retrieve_client

Retrieve a client Parameters:
ParameterTypeRequiredDefaultDescription
clientIdstringYesClient Id

harvest_people_retrieve_company

Retrieve a company

harvest_people_retrieve_contact

Retrieve a contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesContact Id

harvest_people_retrieve_cost_rate

Retrieve a cost rate Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser Id
costRateIdstringYesCost Rate Id

harvest_people_retrieve_role

Retrieve a role Parameters:
ParameterTypeRequiredDefaultDescription
roleIdstringYesRole Id

harvest_people_retrieve_the_currently_authenticated_user

Retrieve the currently authenticated user

harvest_people_retrieve_user

Retrieve a user Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser Id

harvest_people_update_client

Update a client Parameters:
ParameterTypeRequiredDefaultDescription
clientIdstringYesClient Id
addressstringNoA textual representation of the client’s physical address. May include new line characters.
currencystringNoThe currency used by the client. See a list of supported currencies
is_activebooleanNoWhether the client is active, or archived.
namestringNoA textual description of the client.

harvest_people_update_company

Update a company Parameters:
ParameterTypeRequiredDefaultDescription
wants_timestamp_timersbooleanNoWhether time is tracked via duration or start and end times.
weekly_capacityintegerNoThe weekly capacity in seconds.

harvest_people_update_contact

Update a contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesContact Id
client_idintegerNoThe ID of the client associated with this contact.
emailstringNoThe contact’s email address.
faxstringNoThe contact’s fax number.
first_namestringNoThe first name of the contact.
invoice_recipient_statusstringNoThe contact’s default role on the client’s invoices (Invoice email default in the web UI). One of none, recipient, cc, or bcc. Defaults to none.
last_namestringNoThe last name of the contact.
phone_mobilestringNoThe contact’s mobile phone number.
phone_officestringNoThe contact’s office phone number.
titlestringNoThe title of the contact.

harvest_people_update_role

Update a role Parameters:
ParameterTypeRequiredDefaultDescription
roleIdstringYesRole Id
namestringNoThe name of the role.
user_idsinteger[]NoThe IDs of the users assigned to this role.

harvest_people_update_user

Update a user Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser Id
access_rolesstring[]NoAccess role(s) that determine the user’s permissions in Harvest. Possible values: administrator, manager or member. Users with the manager role can additionally be granted one or more of these roles: project_creator, billable_rates_manager, managed_projects_invoice_drafter, managed_projects_invoice_manager, client_and_task_manager, time_and_expenses_manager, estimates_manager.
emailstringNoThe email address of the user. Can’t be updated if the user is inactive.
first_namestringNoThe first name of the user. Can’t be updated if the user is inactive.
has_access_to_all_future_projectsbooleanNoWhether the user should be automatically added to future projects.
is_activebooleanNoWhether the user is active or archived.
is_contractorbooleanNoWhether the user is a contractor or an employee.
last_namestringNoThe last name of the user. Can’t be updated if the user is inactive.
rolesstring[]NoDescriptive names of the business roles assigned to this person. They can be used for filtering reports, and have no effect in their permissions in Harvest.
timezonestringNoThe user’s timezone. Defaults to the company’s timezone. See a list of supported time zones.
weekly_capacityintegerNoThe number of hours per week this person is available to work in seconds.

harvest_people_update_user_assigned_teammates

Update a user’s assigned teammates Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser Id
teammate_idsinteger[]YesFull list of user IDs to be assigned to the Manager.