Team Members

The team members resource is how you interact with employees/users of your FreshBooks business. This supersedes the Staff resource which was used primarily by FreshBooks Classic.

Access Requirements

Access	Requires Authorization
Scopes	`user:teams:read`

Filters

Filter Type	Name	Field	Description
Bool	active	active	If true, returns only the active team members

Field Descriptions

Field	Type	Description
uuid	string	Unique id of the team member
first_name	string	First name
middle_name	string	Middle name
last_name	string	Last name
email	string	Email
job_title	string	Job Title
street_1	string	Street address
street_2	string	Second line of the street address
city	string	City
province	string	Province/State
country	string	Country
postal_code	string	Postal/ZIP Code
phone_number	string	Phone Number
business_id	int	The id of this business
business_role_name	string	Team member's role in the business
active	bool	Whether the member is active or not
identity_id	int	The identity_id of the team member if they have a FreshBooks account
invitation_date_accepted	DateTime	The date/time the team member accepted their invitation
created_at	DateTime	The date/time the team member was created
updated_at	DateTime	The date/time the team member was last modified

List Team Members

Request: GET "https://api.freshbooks.com/auth/api/v1/businesses/<business_id>/team_members"

Response:
{
    "response": [
        {
            "uuid": "dd6392d0-0639-40bd-9502-7d80c44de9f3",
            "first_name": "John",
            "middle_name": null,
            "last_name": "Doe",
            "email": "test@freshenv.com",
            "job_title": null,
            "street_1": null,
            "street_2": null,
            "city": null,
            "province": null,
            "country": null,
            "postal_code": null,
            "phone_number": null,
            "business_id": 6806492,
            "business_role_name": "business_employee",
            "active": false,
            "identity_id": null,
            "invitation_date_accepted": null,
            "created_at": "2023-01-24T17:17:56Z",
            "updated_at": "2023-03-01T09:45:42Z"
        }
    ],
    "meta": {
        "page": 1,
        "per_page": 5,
        "total": 1
    }
}

Get Single Team Member

Request: GET "https://api.freshbooks.com/auth/api/v1/businesses/<business_id>/team_members/<team_member_uuid>"

Response:
{
    "response": {
        "uuid": "879dd802-2ec2-4683-9165-8ecdfcae4e2a",
        "first_name": "Jane",
        "middle_name": null,
        "last_name": "Doe",
        "email": "test1@freshenv.com",
        "job_title": null,
        "street_1": null,
        "street_2": "street 2",
        "city": null,
        "province": null,
        "country": "United States",
        "postal_code": null,
        "phone_number": null,
        "business_id": 6806492,
        "business_role_name": "no_seat_employee",
        "active": true,
        "identity_id": null,
        "invitation_date_accepted": null,
        "created_at": "2023-03-22T16:52:01Z",
        "updated_at": "2023-04-11T12:36:04Z"
    }
}