FreshBooks

Search


API Calls

Resources

Projects

Staff have access to the API calls listed below if the Time Tracking tab is enabled for staff. Each staff member can view all projects to which he or she is assigned. Each staff member can edit only those projects on which he or she is the Project Manager. Limited information is returned about projects that the staff member is assigned to, but not the manager of.

project.create

Create a new project. If you specify project-rate or flat-rate for bill_method, you must supply a rate.

Billing Method Types
  • task-rate
  • flat-rate
  • project-rate
  • staff-rate

Request

<?xml version="1.0" encoding="utf-8"?>

  
    Website Redesign            
    project-rate  
    21                
    45.00                       
    

                                      
      5
      8
      22
    
  

Response

<?xml version="1.0" encoding="utf-8"?>

  15

project.update

Update an existing project.

Request

<?xml version="1.0" encoding="utf-8"?>

  
    15

    
  

Response

<?xml version="1.0" encoding="utf-8"?>

project.get

Retrieve an existing project.

Note:
  • Staff IDs for staff members who are assigned to a project will only appear for admins and project managers.

Request

<?xml version="1.0" encoding="utf-8"?>

  6

Response

<?xml version="1.0" encoding="utf-8"?>

  
    6
    Super Fun Project
    
    11000
    flat-rate
    119
    
        1
        2
        3
    
  
	

project.delete

Delete an existing project.

Request

<?xml version="1.0" encoding="utf-8"?>

  15

Response

<?xml version="1.0" encoding="utf-8"?>
	

project.list

Returns a list of projects in alphabetical order.

Filters
  • client_id - return only projects assigned to this client
  • task_id - return only projects with the given task
Note:
  • Staff IDs for staff members who are assigned to a project will only appear for admins and project managers.

Request

<?xml version="1.0" encoding="utf-8"?>

  1                        
  15               

Response

<?xml version="1.0" encoding="utf-8"?>

  
    6
    Super Fun Project
    
    11000
    flat-rate
    119
    
        1
        2
        3
    
  
  
    ...
  
  ...