× FreshBooks App Logo
FreshBooks
Official App
Free - Google Play
Get it
You're currently on our US site. Select your regional site here:

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

AccessRequires Authorization
Scopesuser:teams:read

Filters

Filter TypeNameFieldDescription
BoolactiveactiveIf true, returns only the active team members

Field Descriptions

FieldTypeDescription
uuidstringUnique id of the team member
first_namestringFirst name
middle_namestringMiddle name
last_namestringLast name
emailstringEmail
job_titlestringJob Title
street_1stringStreet address
street_2stringSecond line of the street address
citystringCity
provincestringProvince/State
countrystringCountry
postal_codestringPostal/ZIP Code
phone_numberstringPhone Number
business_idintThe id of this business
business_role_namestringTeam member’s role in the business
activeboolWhether the member is active or not
identity_idintThe identity_id of the team member if they have a FreshBooks account
invitation_date_acceptedDateTimeThe date/time the team member accepted their invitation
created_atDateTimeThe date/time the team member was created
updated_atDateTimeThe 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"
    }
}