Sign in

v1

latestOpenAPI 3.0.32026-07-246304082.0 MB
projects

Return all the projects the user can access

get/api/v3/projects

Query parameters

last_synced_atstring date-time

Timestamp since when further updates should be included

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[name_like]string
Example:Project 1

Filter on name field being like passed in value

filters[name_eq]string
Example:Project 1

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

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

filters[project_attribute_name_like]string
Example:Test Value

Filter on project_attribute_name field being like passed in value

filters[project_attribute_name_eq]string
Example:Test Value

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

filters[code_eq]string
Example:Test Value

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

filters[project_user_id_eq]string
Example:100

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

filters[account_owner_id_eq]string
Example:100

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

filters[archived_eq]string
Example:true

Filter on archived field being equal to passed in value

Headers

Fieldwire-Filter'active' | 'deleted'

Specifies if request should include active, deleted or all (default) entities

Fieldwire-Per-Pageinteger

Specifies the number of entities to include in the request

Fieldwire-Versionstring date required

Specifies the version of the API to talk to

Response

Successful response

idstring uuid required

ID of the entity

account_idinteger required

Account id project is under

has_logoboolean required

Boolean if project has logo

is_3d_bim_enabledboolean nullable

If 3D BIM is enabled for this project

is_mobile_location_creation_enabledboolean nullable

If location creation on mobile is enabled for this project

is_email_notifications_enabledboolean required

Whether email notifications are enabled for this project

is_plan_text_search_enabledboolean

Whether plan text search is enabled for this project

prompt_effort_on_completeboolean required

Whether prompt to input effort should be shown on marking tasks as completed

addressstring nullable

Address of this project

codestring nullable

Code of this project

colorstring required

Color to use for this project for highlighting in the UI

currencystring required

Currency to use for the cost_value of Tasks in this project

default_pm_group_idstring uuid nullable

The default PmGroup for this project, if it is a PM-enabled project

logo_urlstring nullable

URL of the logo for this project

man_power_unitsstring required

Unit to use for the man_power_value of Tasks in this project

namestring required

Name of this project

time_zonestring required

Timezone of this project

min_verified_at_daysinteger

Count of days after which verified tasks are archived

sheets_limitinteger nullable

Count of the latest sheet versions that should be cached on the mobile apps

owner_emailstring nullable

Email of user who owns the project

plan_name'Basic' | 'Pro' | 'Business' | 'Enterprise'

Tier this project belongs to

is_premiumboolean required

If this is a premium project

is_enterpriseboolean required

If this project is an enterprise project

work_weekboolean[] nullable

Array of seven boolean values indicating whether Sunday-Saturday are work days

archived_atstring date-time nullable

Time when this project was archived

created_atstring date-time required

Time when the server created the entity

device_created_atstring date-time required

Time when the device created the entity

resolved_conflictboolean required

Specifies if PUT/PATCH request was rejected - do not store this field!

device_updated_atstring date-time required

Time when the device last updated the entity

updated_atstring date-time required

Time when the server last updated the entity

deleted_atstring date-time nullable

Time the server deleted the entity

is_analytics_enabledboolean

Whether analytics is enabled for this project

is_forms_enabledboolean

Whether Forms tab should be shown for this project

is_photo_attachments_enabledboolean

Whether Photos tab should be shown for this project

is_plan_email_notifications_enabledboolean

Whether notifications should be sent out on processing plans

is_tasks_enabledboolean

Whether Tasks tab should be shown for this project

tz_name'Etc/GMT+12' | 'Pacific/Midway' | 'Pacific/Pago_Pago' | 'Pacific/Honolulu' | 'America/Juneau' | 'America/Los_Angeles' | 'America/Tijuana' | 'America/Denver' | 'America/Phoenix' | 'America/Chihuahua' | 'America/Mazatlan' | 'America/Chicago' | 'America/Regina' | 'America/Mexico_City' | 'America/Mexico_City' | 'America/Monterrey' | 'America/Guatemala' | 'America/New_York' | 'America/Indiana/Indianapolis' | 'America/Bogota' | 'America/Lima' | 'America/Lima' | 'America/Halifax' | 'America/Caracas' | 'America/La_Paz' | 'America/Santiago' | 'America/St_Johns' | 'America/Sao_Paulo' | 'America/Argentina/Buenos_Aires' | 'America/Montevideo' | 'America/Guyana' | 'America/Puerto_Rico' | 'America/Godthab' | 'Atlantic/South_Georgia' | 'Atlantic/Azores' | 'Atlantic/Cape_Verde' | 'Europe/Dublin' | 'Europe/London' | 'Europe/Lisbon' | 'Europe/London' | 'Africa/Casablanca' | 'Africa/Monrovia' | 'Etc/UTC' | 'Europe/Belgrade' | 'Europe/Bratislava' | 'Europe/Budapest' | 'Europe/Ljubljana' | 'Europe/Prague' | 'Europe/Sarajevo' | 'Europe/Skopje' | 'Europe/Warsaw' | 'Europe/Zagreb' | 'Europe/Brussels' | 'Europe/Copenhagen' | 'Europe/Madrid' | 'Europe/Paris' | 'Europe/Amsterdam' | 'Europe/Berlin' | 'Europe/Zurich' | 'Europe/Zurich' | 'Europe/Rome' | 'Europe/Stockholm' | 'Europe/Vienna' | 'Africa/Algiers' | 'Europe/Bucharest' | 'Africa/Cairo' | 'Europe/Helsinki' | 'Europe/Kiev' | 'Europe/Riga' | 'Europe/Sofia' | 'Europe/Tallinn' | 'Europe/Vilnius' | 'Europe/Athens' | 'Europe/Istanbul' | 'Europe/Minsk' | 'Asia/Jerusalem' | 'Africa/Harare' | 'Africa/Johannesburg' | 'Europe/Kaliningrad' | 'Europe/Moscow' | 'Europe/Moscow' | 'Europe/Volgograd' | 'Europe/Samara' | 'Asia/Kuwait' | 'Asia/Riyadh' | 'Africa/Nairobi' | 'Asia/Baghdad' | 'Asia/Tehran' | 'Asia/Muscat' | 'Asia/Muscat' | 'Asia/Baku' | 'Asia/Tbilisi' | 'Asia/Yerevan' | 'Asia/Kabul' | 'Asia/Yekaterinburg' | 'Asia/Karachi' | 'Asia/Karachi' | 'Asia/Tashkent' | 'Asia/Kolkata' | 'Asia/Kolkata' | 'Asia/Kolkata' | 'Asia/Kolkata' | 'Asia/Kathmandu' | 'Asia/Dhaka' | 'Asia/Colombo' | 'Asia/Almaty' | 'Asia/Almaty' | 'Asia/Novosibirsk' | 'Asia/Rangoon' | 'Asia/Bangkok' | 'Asia/Bangkok' | 'Asia/Jakarta' | 'Asia/Krasnoyarsk' | 'Asia/Shanghai' | 'Asia/Chongqing' | 'Asia/Hong_Kong' | 'Asia/Urumqi' | 'Asia/Kuala_Lumpur' | 'Asia/Singapore' | 'Asia/Taipei' | 'Australia/Perth' | 'Asia/Irkutsk' | 'Asia/Ulaanbaatar' | 'Asia/Seoul' | 'Asia/Tokyo' | 'Asia/Tokyo' | 'Asia/Tokyo' | 'Asia/Yakutsk' | 'Australia/Darwin' | 'Australia/Adelaide' | 'Australia/Canberra' | 'Australia/Melbourne' | 'Australia/Sydney' | 'Australia/Brisbane' | 'Australia/Hobart' | 'Asia/Vladivostok' | 'Pacific/Guam' | 'Pacific/Port_Moresby' | 'Asia/Magadan' | 'Asia/Srednekolymsk' | 'Pacific/Guadalcanal' | 'Pacific/Noumea' | 'Pacific/Fiji' | 'Asia/Kamchatka' | 'Pacific/Majuro' | 'Pacific/Auckland' | 'Pacific/Auckland' | 'Pacific/Tongatapu' | 'Pacific/Fakaofo' | 'Pacific/Chatham' | 'Pacific/Apia' nullable

Timezone of this project

measurement_units'imperial' | 'metric'

Unit to use for the measurements show on plans

trial_end_atstring date-time nullable

Time when the trial for this project ends

is_task_status_enabledboolean nullable

Whether this project can have custom task statuses (denoted by Status)

min_api_versionstring date nullable

Minimum Fieldwire API version required to use this project

pm_group_idstring uuid nullable

Id of PM Group for user of this project

is_project_labels_enabledboolean

Whether Project Labels should be shown for this project