×
Freshbooks
Official App
Free – Google Play
Get it
Skip to Main Content
FreshBooks is Loved by American Small Business Owners
FreshBooks is Loved by Canadian Small Business Owners
FreshBooks is Loved by Small Business Owners in the UK

Staff

staff.current

Return the current user’s details. Staff have access to this call, but only for their own staff_id.

Request

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

Response

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

  
    1
    John
    John
    Smith
    John@example.org
    
    
    0
    2010-07-12 13:55:58
    700
    2010-07-07 10:38:57
    
    
    
    
    
    
  

staff.get

Return the complete staff details associated with the given staff_id. Staff have access to this call, but only for their own staff_id.

Request

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

  2

Response

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

  
    2
    staff1
    test
    test2
    jsmith@abcorp.com
    (123) 456-7890
    (123) 456-7890
    0
    2008-11-20 13:26:00
    13
    2008-10-22 13:57:00
    123 ABC Street
    
    Toronto
    Ontario
    Canada
    M1M 1A1
  

staff.list

Returns a list of staff.

Note: This method uses pagination.

Request

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


Response

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

  
    
      1
      admin
      
      abcorp
      abc@abcorp.com
      
      
      
      2011-04-01 12:00:00
      50
      2011-04-01 12:00:00
      
      
      
      
      
      
    
    
      2
      staff1
      John
      Smith
      jsmith@abcorp.com
      
      
      
      2011-04-01 12:00:00
      25
      2011-04-01 12:00:00
      
      
      
      
      
      
    

staff.create

Creates a new staff member

Request

 <?xml version="1.0" encoding="utf-8"?>
 
       
              John
              Doe
              jdoe@example.com
              
              user
              pass
              
              1
              Canada
              Ontario
              Toronto
              123 Fake St.
              Apt 2
              M5M3M4
              5555555
              41611111111
              416-2222222
              416-3333333
              75.5 
              
                     
                            2
                     
              
       
 
 

Response

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

  37

staff.update

Updates an existing staff member.

Request

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

    
        2                                 
        first
        last
        first-last@test.com
        first-last
        secret
        
        1
        brazil
        my state
        my city
        some street 1
        some street 2
        12345
        416-0000000
        416-1111111
        416-2222222
        416-3333333
        34.5
        
        
            
                2
            
            
                3
            
        
        some notes not visible by staff members
    

Response

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

staff.delete

Deletes the specified staff member.

Request

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

    2

Response

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