API Documentation

Time Tracking

Extended REST API
Clients
Projects
Tasks
People
Expenses
Expense Tracking
User Assignment
Task Assignment
Reports
Invoices
Invoice Messages
Invoice Payments
Invoice Categories


Questions?
Email support@getharvest.com

User Assignment: Assigning people to projects

Get all users assigned to a given project

GET /projects/#{project_id}/user_assignments

HTTP Response: 200 OK
<user-assignments>
  <user-assignment>
    <id>3</id>  
    <user-id>1</user-id>
    <project-id>3</project-id>
    <!-- If true, user cannot log more hours toward the project -->
    <deactivated>false</deactivated>
    <!-- Hourly rate of user on current project -->
    <hourly-rate>100.0</hourly-rate>
    <!-- If true, user has project manager permission on this project -->
    <is-project-manager>true</is-project-manager>
  </user-assignment>
  <user-assignment>
    ...
  </user-assignment>
</user-assignments>

Get a user assignment

GET /projects/#{project_id}/user_assignments/#{user_assignment_id}

HTTP Response: 200 OK
<user-assignment>
  <id>3</id>  
  <user-id>1</user-id>
  <project-id>3</project-id>
  <!-- If true, user cannot log more hours toward the project -->
  <deactivated>false</deactivated>
  <!-- Hourly rate of user on current project -->
  <hourly-rate>100.0</hourly-rate>
  <!-- If true, user has project manager permission on this project -->
  <is-project-manager>true</is-project-manager>
</user-assignment>

Assign a user to a project

POST /projects/#{project_id}/user_assignments

HTTP Response: 201 Created
Location: /projects/#{project_id}/user_assignments/#{new_user_assignment_id}

You will have to post the following:

<user>
 <id>23445<id>
<user>

Removing a user from a project

DELETE /projects/#{project_id}/user_assignments/#{user_assignment_id}

HTTP Response: 200 OK

Note that if the user has recorded hours against the project Harvest will archive the assignment record instead of deleting it. From the end result there is no difference between archiving or deletion, but if you need to make a difference Harvest will reply with a custom Hint header if deletion did not occur.


Changing a user inside a project

PUT /projects/#{project_id}/user_assignments/#{user_assignment_id}

HTTP Response: 200 OK
Location: /projects/#{project_id}/user_assignments/#{new_user_assignment_id}

You will have to post the following:

<user-assignment>
  <user-id>1423</user-id>
  <project-id>3423</project-id>
  <deactivated>true</deactivated>
  <hourly-rate>95.0</hourly-rate>
  <is-project-manager>false</is-project-manager>
</user-assignment>