Sign in

v1

latestOpenAPI 3.0.32026-07-246304082.0 MB
account projects users

Show all projects users for an account

get/api/v3/account/projects/{project_id}/users

Path parameters

project_idstring uuid required

ID of the project this entity belongs to

Query parameters

filters[email_like]string
Example:user@email.com

Filter on email field being like passed in value

filters[email_eq]string
Example:user@email.com

Filter on email field being equal to passed in value, allows for filtering with a array of values

filters[last_name_like]string
Example:User 1

Filter on last_name field being like passed in value

filters[last_name_eq]string
Example:User 1

Filter on last_name field being equal to passed in value, allows for filtering with a array of values

filters[first_name_like]string
Example:User 1

Filter on first_name field being like passed in value

filters[first_name_eq]string
Example:User 1

Filter on first_name field being equal to passed in value, allows for filtering with a array of values

filters[phone_number_like]string
Example:+1 (555) 800-5555

Filter on phone_number field being like passed in value

filters[company_like]string
Example:Fieldwire

Filter on company field being like passed in value

filters[company_eq]string
Example:Fieldwire

Filter on company field being equal to passed in value, allows for filtering with a array of values

filters[job_title_like]string
Example:User Job

Filter on job_title field being like passed in value

filters[job_title_eq]string
Example:User Job

Filter on job_title field being equal to passed in value, allows for filtering with a array of values

filters[language_eq]string
Example:en

Filter on language field being equal to passed in value, allows for filtering with a array of values

filters[is_confirmed_eq]string
Example:true

Filter on is_confirmed field being equal to passed in value

filters[created_at_gte]string
Example:2009-06-15T13:45:30Z

Filter on created_at field being greater than or equal to the passed in value

filters[created_at_gt]string
Example:2009-06-15T13:45:30Z

Filter on created_at field being greater than the passed in value

filters[created_at_lte]string
Example:2009-06-15T13:45:30Z

Filter on created_at field being less than or equal to the passed in value

filters[created_at_lt]string
Example:2009-06-15T13:45:30Z

Filter on created_at field being less than to the passed in value

filters[updated_at_gte]string
Example:2009-06-15T13:45:30Z

Filter on updated_at field being greater than or equal to the passed in value

filters[updated_at_gt]string
Example:2009-06-15T13:45:30Z

Filter on updated_at field being greater than the passed in value

filters[updated_at_lte]string
Example:2009-06-15T13:45:30Z

Filter on updated_at field being less than or equal to the passed in value

filters[updated_at_lt]string
Example:2009-06-15T13:45:30Z

Filter on updated_at field being less than to the passed in value

Headers

Fieldwire-Versionstring date required

Specifies the version of the API to talk to

Response

Successful response

idinteger required

ID of user

account_idinteger nullable

ID of the account this user belongs to

invited_by_idinteger nullable

ID of the user who invited this user to the platform

is_email_deliverableboolean required

If email can be delivered to this user

companystring nullable

Name of the company this user belongs to

company_type'ARCHITECT_SLASH_DESIGNER' | 'GENERAL_CONTRACTOR' | 'OWNER' | 'SPECIALTY_CONTRACTOR' | 'OTHER' | 'null' nullable

Type of the company this user belongs to

emailstring required

Email of this user

first_namestring required

First name of this user

job_titlestring nullable

Title this user holds at their job

languagestring required

Preferred language of this user

last_namestring required

Last name of this user

phone_numberstring nullable

Phone number of this user

photo_urlstring nullable

URL where the profile picture of this user lives

email_notifications'never' | 'daily' | 'instantly' | 'null' nullable

Email notification preference of this user for delivering task updates

sync_scheme'smart_cellular' | 'full_cellular' required

Synchronization scheme of this user used by the mobile apps

email_addressesobject[]

Deprecated. Use the "email" property instead

is_confirmedboolean

Whether the user has accepted the invitation if there was one

created_atstring date-time required

Time when the server created this user

current_sign_in_atstring date-time nullable

Last time the user was seen online

in_app_purchase_end_atstring date-time nullable

When the in app purchase this user made ends

updated_atstring date-time required

Time when the server last updated this user

trade_type'CONCRETE' | 'EARTHWORK' | 'ELECTRICAL' | 'FIRE_SUPPRESSION' | 'FRAMING_AND_OR_DRYWALL' | 'HVAC' | 'LOW_VOLTAGE' | 'MECHANICAL' | 'PLUMBING' | 'UTILITIES' | 'OTHER' | 'null' nullable

Type of the trade this user's company belongs to

is_approvedboolean nullable

If this user is approved to be a part of the project

project_idstring uuid

ID of the project this user belongs to

is_adminboolean nullable

If this user is an admin in this project

user_deleted_atstring date-time nullable

Time when this user was deleted from this project

user_blocked_atstring date-time nullable

Deprected: Time when this user was blocked from accessing this project

role'admin' | 'member' | 'follower' | 'null' nullable

Role this user holds in this project