Jump to Content
API Guide
API Reference
Q&A
Changelog
Fieldwire App
Home
API Guide
API Reference
Changelog
Q&A
v3
v3.1
API Guide
API Reference
Q&A
Changelog
Fieldwire App
API Reference
Moon (Dark Mode)
Sun (Light Mode)
v3.1
API Reference
My Requests
Search
All
Pages
Start typing to search…
JUMP TO
My Requests
Fieldwire Super API
accounts
Show account information
get
Update an account
patch
account users
Show all users for an account
get
Get user by ID
get
Update the account info for a user
patch
Remove a user from account
del
Update the profile of a user in account
patch
Invite a new or existing user to account
post
Update the account_role for a list of user ids
patch
Remove a batch of users from the account
del
api keys
Generate a JSON Web Token (JWT)
post
Fieldwire Regional API
access control files
Get stored file by id
get
account attachments
Get all account_attachments in project template
get
Get all account_attachments in account
get
Create a new account_attachment
post
Get account_attachment by ID
get
Update account_attachment by ID
patch
Delete account_attachment by ID
del
Restore account_attachment by ID
put
account data types
Get all account_data_types in account
get
Create a new account_data_type
post
Get account_data_type by ID
get
Update account_data_type by ID
patch
Delete account_data_type by ID
del
Restore account_data_type by ID
put
Get the AFTs that use this account data type
get
Get the AFTs or Project Template Task Type Attributes that use this account data type
get
account data type values
Get all account_data_type_values in account
get
Create a new account_data_type_value
post
Get account_data_type_value by ID
get
Update account_data_type_value by ID
patch
Delete account_data_type_value by ID
del
Restore account_data_type_value by ID
put
account form template form statuses
Get all account_form_template_form_statuses in account
get
Create a new account_form_template_form_status
post
Get account_form_template_form_status by ID
get
Update account_form_template_form_status by ID
patch
Delete account_form_template_form_status by ID
del
Restore account_form_template_form_status by ID
put
Reorder account_form_template_form_status based on sibling
put
account form template permissions
Get all account_form_template_permissions in account
get
account form template section record inputs
Get all account_form_template_section_record_inputs in account
get
Create a new account_form_template_section_record_input
post
Get account_form_template_section_record_input by ID
get
Update account_form_template_section_record_input by ID
patch
Delete account_form_template_section_record_input by ID
del
Restore account_form_template_section_record_input by ID
put
Reorder account_form_template_section_record_input based on sibling
put
Update batch of account_form_template_section_record_inputs by IDs
patch
account form template section records
Get all account_form_template_section_records in account
get
Create a new account_form_template_section_record
post
Get account_form_template_section_record by ID
get
Update account_form_template_section_record by ID
patch
Delete account_form_template_section_record by ID
del
Restore account_form_template_section_record by ID
put
Reorder account_form_template_section_record based on sibling
put
account form template sections
Get all account_form_template_sections in account
get
Create a new account_form_template_section
post
Get account_form_template_section by ID
get
Update account_form_template_section by ID
patch
Delete account_form_template_section by ID
del
Restore account_form_template_section by ID
put
Reorder account_form_template_section based on sibling
put
account form templates
Get all account_form_templates in account
get
Create a new account_form_template
post
Get account_form_template by ID
get
Update account_form_template by ID
patch
Delete account_form_template by ID
del
Restore account_form_template by ID
put
Generate newly created account form template
post
Publish or unpublish an existing account form template
put
Transfers specified AFTs to the specified project
post
Duplicate the given account form template on the same account
post
Show the full account form template corresponding to the provided id
get
Generate specified default account form template to the account
post
default account form templates
Returns all default account template codes
get
projects
Show all projects in an account
get
Destroy a account projects
del
Update a project in account
patch
Return all the projects the user can access
get
Create a new project
post
Destroy a projects
del
Show the project with the id provided in the path request
get
Update a project
patch
Return the activity of the project (the last updated timestamp of project elements)
get
Disconnect project synchronisation
post
Send a notification to the project
post
Setup project synchronisation
post
Fetch the email from the project cloud storage
post
Show the sync status of the project with the id provided in the path request
get
Transfer a project to another user
post
account project stats
Show all ProjectStats associated with the account
get
account projects users
Show all projects users for an account
get
Update the project info for a user
patch
Remove a user from project
del
account users
[DEPRECATED] Remove a batch of users from the account and all its projects
del
Remove a batch of users from all the projects of an account
del
account users projects
Show all account users projects
get
attachment markups
Get attachment_markup by ID
get
Update attachment_markup by ID
patch
Delete attachment_markup by ID
del
Create a new attachment_markup
post
Get all attachment_markups in project
get
Get all attachment_markups in project for an attachment
get
Get all attachment_markups in project for an rfi_attachment
get
Flatten image with markups for markupable
post
attachments
Get attachment by ID
get
Update attachment by ID
patch
Delete attachment by ID
del
Create a new attachment
post
Get all attachments in project
get
Restore attachment by ID
put
Create several attachments at once
post
Return all hyperlinks related to the attachment
get
Return all multi hyperlinks related to the attachment
get
Create a new attachment
post
attachments multi hyperlink markups
Get all attachments_multi_hyperlink_markups in project
get
Create a new attachments_multi_hyperlink_markup
post
Update attachments_multi_hyperlink_markup by ID
patch
Delete attachments_multi_hyperlink_markup by ID
del
Get attachments_multi_hyperlink_markups in project for an attachments_multi_hyperlink
get
Flatten image with markups for attachments_multi_hyperlinks
post
Get bubble_markups in project for an bubble
get
attachments multi hyperlinks
Get all attachments_multi_hyperlinks in project
get
Create a new attachments_multi_hyperlink
post
Get attachments_multi_hyperlink by ID
get
Update attachments_multi_hyperlink by ID
patch
Delete attachments_multi_hyperlink via attachment by ID originating in a floorplan
del
get an attachments_multi_hyperlink from a multi_hyperlink
get
automatic hyperlinks
Get all automatic_hyperlinks in project
get
Get automatic_hyperlink by ID
get
Update automatic_hyperlink by ID
patch
Delete automatic_hyperlink by ID
del
Restore automatic_hyperlink by ID
put
Show all automatic_hyperlinks in a sheet
get
aws post tokens
Acquire permission & location to upload files
post
bubble markups
Get all bubble_markups in project
get
Get bubble_markup by ID
get
Update bubble_markup by ID
patch
Delete bubble_markup by ID
del
Create a new bubble markup
post
bubbles
Get all bubbles in project
get
Get bubble by ID
get
Update bubble by ID
patch
Delete bubble by ID
del
Flatten a bubble
post
Get all bubbles in task
get
Create a new bubble in task
post
building information models
Get all building_information_models in project
get
Get building_information_model by ID
get
Update building_information_model by ID
patch
Delete building_information_model by ID
del
Create a building information model with one version
post
building information model versions
Get all building_information_model_versions in project
get
Get building_information_model_version by ID
get
Delete building_information_model_version by ID
del
custom stamps
Create a new custom_stamp
post
Get all custom_stamps in account
get
Delete custom_stamp by ID
del
custom symbols
Get all custom_symbols in project
get
Create a new custom_symbol
post
Get custom_symbol by ID
get
Update custom_symbol by ID
patch
Delete custom_symbol by ID
del
Restore custom_symbol by ID
put
data types
Get all data_types in project
get
Create a new data_type
post
Get data_type by ID
get
Update data_type by ID
patch
Restore data_type by ID
put
data type values
Get all data_type_values in project
get
Create a new data_type_value
post
Get data_type_value by ID
get
Update data_type_value by ID
patch
Delete data_type_value by ID
del
Restore data_type_value by ID
put
entity tags
Get all entity_tags in project
get
Create a new entity_tag
post
Get entity_tag by ID
get
Update entity_tag by ID
patch
Delete entity_tag by ID
del
entity taggings
Get all entity_taggings in project
get
Create a new entity_tagging
post
Get entity_tagging by ID
get
Delete entity_tagging by ID
del
Batch create new entity_taggings
post
Batch destroy active entity_taggings
del
extracted submittal logs
Get all extracted_submittal_logs in project
get
creates extracted submittal logs
post
acknowledges all of a users recent extracted submittal logs
post
creates extracted submittal log for all spec sections
post
budget line items
Get all budget line items in project
get
Create a new budget_line_item
post
Update budget_line_item by ID
patch
Delete budget_line_item by ID
del
financials import
Batch create budget_line_items
post
Batch create tier_one_cost_codes and tier_two_cost_codes
post
tier one cost codes
Get all tier one cost codes in project
get
Create a new tier_one_cost_code
post
Update tier_one_cost_code by ID
patch
Delete tier_one_cost_code by ID
del
tier two cost codes
Get all tier two cost codes in project
get
Create a new tier_two_cost_code
post
Update tier_two_cost_code by ID
patch
Delete tier_two_cost_code by ID
del
floorplans
Get floorplan by ID
get
Update floorplan by ID
patch
Delete floorplan by ID
del
Restore floorplan by ID
put
Get all floorplans in project
get
Batch export Floorplans
post
Export Markup Summary From Floorplans
post
Runs OCR on Floorplans
post
Adds a few sample Floorplans to the project & returns them
post
Export a Floorplan (Retrieve)
post
Rotate a Floorplan
put
Merge a Floorplan by Name
put
folders
Get all folders in project
get
Create a new folder
post
Get folder by ID
get
Update folder by ID
patch
Delete folder by ID
del
Restore folder by ID
put
form permissions
Get all form_permissions in project
get
form section record inputs
Get all form_section_record_inputs in project
get
Create a new form_section_record_input
post
Get form_section_record_input by ID
get
Update form_section_record_input by ID
patch
Delete form_section_record_input by ID
del
Restore form_section_record_input by ID
put
form section record input value markups
Get all form_section_record_input_value_markups in project
get
Create a new form_section_record_input_value_markup
post
Update form_section_record_input_value_markup by ID
patch
Delete form_section_record_input_value_markup by ID
del
Get form_section_record_input_value_markups in project for an form_section_record_input_value_id
get
Flatten image with markups for form_section_record_input_value
post
form section record input values
Get all form_section_record_input_values in project
get
Create a new form_section_record_input_value
post
Get form_section_record_input_value by ID
get
Update form_section_record_input_value by ID
patch
Delete form_section_record_input_value by ID
del
Restore form_section_record_input_value by ID
put
form section records
Get all form_section_records in project
get
Create a new form_section_record
post
Get form_section_record by ID
get
Update form_section_record by ID
patch
Delete form_section_record by ID
del
Restore form_section_record by ID
put
form section record values
Get all form_section_record_values in project
get
Create a new form_section_record_value
post
Get form_section_record_value by ID
get
Update form_section_record_value by ID
patch
Delete form_section_record_value by ID
del
Restore form_section_record_value by ID
put
form sections
Get all form_sections in project
get
Create a new form_section
post
Get form_section by ID
get
Update form_section by ID
patch
Delete form_section by ID
del
Restore form_section by ID
put
forms
Get all forms in project
get
Create a new form kicks off required sidekiq workers
post
Get form by ID
get
Update form by ID
patch
Delete form by ID
del
Restore form by ID
put
Export the forms matching the form_ids in pdf or csv as asked
post
Export a form
post
Generate a new form
post
form_email
post
Show the full form corresponding to the provided id
get
Validates a form checksum
get
form template form statuses
Get all form_template_form_statuses in project
get
Create a new form_template_form_status
post
Get form_template_form_status by ID
get
Update form_template_form_status by ID
patch
Delete form_template_form_status by ID
del
Restore form_template_form_status by ID
put
Reorder form_template_form_status based on sibling
put
form template permissions
Get all form_template_permissions in project
get
form template section record inputs
Get all form_template_section_record_inputs in project
get
Create a new form_template_section_record_input
post
Get form_template_section_record_input by ID
get
Update form_template_section_record_input by ID
patch
Delete form_template_section_record_input by ID
del
Restore form_template_section_record_input by ID
put
Reorder form_template_section_record_input based on sibling
put
Update batch of form_template_section_record_inputs by IDs
patch
form template section records
Get all form_template_section_records in project
get
Create a new form_template_section_record
post
Get form_template_section_record by ID
get
Update form_template_section_record by ID
patch
Delete form_template_section_record by ID
del
Restore form_template_section_record by ID
put
Reorder form_template_section_record based on sibling
put
form template sections
Get all form_template_sections in project
get
Create a new form_template_section
post
Get form_template_section by ID
get
Update form_template_section by ID
patch
Delete form_template_section by ID
del
Restore form_template_section by ID
put
Reorder form_template_section based on sibling
put
form templates
Get all form_templates in project
get
Create a new form_template
post
Get form_template by ID
get
Update form_template by ID
patch
Delete form_template by ID
del
Restore form_template by ID
put
Generate newly created form template
post
Publish or unpublish an existing form template
put
Show the full form template corresponding to the provided id
get
Duplicate the given form template on the same project
post
Transfers the form template to the specified account
post
default form templates
Generate specified default account form template to the account
post
Returns all default account template codes
get
hyperlinks
Get all hyperlinks in project
get
Get hyperlink by ID
get
Update hyperlink by ID
patch
Delete hyperlink by ID
del
Restore hyperlink by ID
put
Show all hyperlinks in a sheet
get
Create a new hyperlink in a sheet
post
locations
Get all locations in project
get
Create a new location
post
Get location by ID
get
Update location by ID
patch
Delete location by ID
del
Restore location by ID
put
Batch create locations
post
Get full_path for location
get
Get active task count for location & its children
get
markups
Get all markups in project
get
Get markup by ID
get
Update markup by ID
patch
Delete markup by ID
del
Restore markup by ID
put
Show all markups in a sheet
get
Create a new markup
post
batch update
patch
batch delete
del
markup symbol categories
Get markup_symbol_category by ID
get
Get all markup_symbol_categories
get
markup symbol category symbols
Get markup_symbol_category_symbol by ID
get
Get all markup_symbol_category_symbols
get
markup symbols
Get markup_symbol by ID
get
Get all markup_symbols
get
multi hyperlinks
Get all multi_hyperlinks in project
get
Get multi_hyperlink by ID
get
Update multi_hyperlink by ID
patch
Delete multi_hyperlink by ID
del
Restore multi_hyperlink by ID
put
Show all multi_hyperlinks in a sheet
get
Create a new multi hyperlink in a sheet
post
pm groups
Get pm_group by ID
get
Update pm_group by ID
patch
Reassign users to pm_group
patch
Create a new pm_group
post
Get all pm_groups in project
get
project attributes
Get project_attribute by ID
get
Delete project_attribute by ID
del
Update project_attribute by ID
patch
Create a new project_attribute
post
Get all project_attributes in account
get
project notifications
Show all project notifications
get
Destroy a project notifications
del
Show the project notifications corresponding to the provided id
get
Mark a project notification as read
patch
Mark all project notifications as read
post
Batch delete all project notifications
del
project stats
Show all project stats
get
project template checklist links
Get all project_template_checklist_links in account
get
Create a new project_template_checklist_link
post
Delete project_template_checklist_link by ID
del
Restore project_template_checklist_link by ID
put
project template checklists links
Show all account template checklist linked to the project template
get
project template entity tags
Get all project_template_entity_tags in project template
get
Get all project_template_entity_tags in account
get
Create a new project_template_entity_tag
post
Get project_template_entity_tag by ID
get
Update project_template_entity_tag by ID
patch
Delete project_template_entity_tag by ID
del
Restore project_template_entity_tag by ID
put
project template entity taggings
Get all project_template_entity_taggings in project template
get
Get all project_template_entity_taggings in account
get
Create a new project_template_entity_tagging
post
Delete project_template_entity_tagging by ID
del
Restore project_template_entity_tagging by ID
put
project template folders
Get all project_template_folders in project template
get
Get all project_template_folders in account
get
Create a new project_template_folder
post
Get project_template_folder by ID
get
Update project_template_folder by ID
patch
Delete project_template_folder by ID
del
Restore project_template_folder by ID
put
project template form template links
Get all project_template_form_template_links in account
get
Create a new project_template_form_template_link
post
Delete project_template_form_template_link by ID
del
Restore project_template_form_template_link by ID
put
Show all account form templates linked to the project template
get
project template reports
Get all project_template_reports in project template
get
Get all project_template_reports in account
get
Create a new project_template_report
post
Get project_template_report by ID
get
Update project_template_report by ID
patch
Delete project_template_report by ID
del
Restore project_template_report by ID
put
project templates
Get all project_templates in account
get
Create a new project_template
post
Get project_template by ID
get
Update project_template by ID
patch
Delete project_template by ID
del
Restore project_template by ID
put
project template account data type lists
Show account data type lists related to project template
get
project template statuses
Get all project_template_statuses in project template
get
Get all project_template_statuses in account
get
Create a new project_template_status
post
Get project_template_status by ID
get
Update project_template_status by ID
patch
Delete project_template_status by ID
del
Restore project_template_status by ID
put
project template task type attributes
Get all project_template_task_type_attributes in project template
get
Get all project_template_task_type_attributes in account
get
Create a new project_template_task_type_attribute
post
Get project_template_task_type_attribute by ID
get
Update project_template_task_type_attribute by ID
patch
Delete project_template_task_type_attribute by ID
del
Restore project_template_task_type_attribute by ID
put
Reorder project_template_task_type_attributes
put
project template task types
Get all project_template_task_types in project template
get
Get all project_template_task_types in account
get
Create a new project_template_task_type
post
Get project_template_task_type by ID
get
Update project_template_task_type by ID
patch
Delete project_template_task_type by ID
del
Restore project_template_task_type by ID
put
project template teams
Get all project_template_teams in project template
get
Get all project_template_teams in account
get
Create a new project_template_team
post
Get project_template_team by ID
get
Update project_template_team by ID
patch
Delete project_template_team by ID
del
Restore project_template_team by ID
put
project template users
Show all account template users linked to the project template
get
Get all project_template_users in account
get
Create a new project_template_user
post
Get project_template_user by ID
get
Update project_template_user by ID
patch
Delete project_template_user by ID
del
Restore project_template_user by ID
put
Create several project template users at once
post
projects project attributes
Get all projects_project_attributes in project
get
Create a new projects_project_attribute
post
Get projects_project_attribute by ID
get
Delete projects_project_attribute by ID
del
Update projects_project_attribute by ID
patch
report templates
Get all report_templates in project
get
Create a new report_template
post
Get report_template by ID
get
Update report_template by ID
patch
Delete report_template by ID
del
Generate & download the report for a given report template
post
Generate & mail the report for a given report template
post
rfi activity logs
Get all rfi_activity_logs in project
get
rfi attachment markups
Get all rfi_attachment_markups in project
get
Create a new rfi_attachment_markup
post
Update rfi_attachment_markup by ID
patch
Delete rfi_attachment_markup by ID
del
Get rfi_attachment_markups in project for an rfi_attachment
get
Flatten image with markups for rfi_attachment
post
rfi attachments
Get all rfi_attachments in project
get
rfis
Get all rfis in project
get
Create a new rfi
post
Get rfi by ID
get
Update rfi by ID
patch
Delete rfi by ID
del
Transition an rfi
patch
rfi watchers
Get all rfi_watchers in project
get
rollups
Show all rollups
get
sheets
Get all sheets in project
get
Get sheet by ID
get
Update sheet by ID
patch
Delete sheet by ID
del
Reorder sheet based on sibling
put
Get all Sheets in a Floorplan
get
Get highlighted search results on a sheet
get
Batch export Sheets
post
sheet uploads
Get all sheet_uploads in project
get
Create a new sheet_upload
post
Get sheet_upload by ID
get
Update sheet_upload by ID
patch
Create several sheet uploads at once
post
Deletes Sheet Uploads or Floorplan if no active sheets remains
post
signatures
Get all signatures in project
get
Create a new signature
post
Get signature by ID
get
Delete signature by ID
del
spec sections
Get all spec_sections in project
get
Create a new spec_section
post
Get spec_section by ID
get
Delete spec_section by ID
del
Update a spec_section and its current spec_section_version
patch
Delete a batch of spec_sections
del
Delete a batch of all spec_sections
del
Resolve a single spec_section
patch
Resolve all spec_sections
patch
Resolve spec_section number conflict
patch
spec section versions
Get spec_section_version by ID
get
Update spec_section_version by ID
patch
Delete a spec_section_version and its associated attachment
del
Get all spec_section_versions in project
get
spec upload draft items
Get all spec_upload_draft_items in project
get
Create a partial spec_upload_draft_item
post
Delete spec_upload_draft_item by ID
del
Update a spec_upload_draft_item with empty fields
patch
spec uploads
Get all spec_uploads in project
get
Create a new spec_upload
post
Delete spec_upload by ID
del
Update spec_upload by ID
patch
Review a spec_upload
post
statuses
Get statuses for project ID
get
Get status by ID
get
submittal actions
Get all submittal_actions in project
get
submittal approval types
Get all submittal_approval_types in project
get
Edit a submittal_approval_type
post
Delete submittal_approval_types by ID
del
submittal attachments
Get all submittal_attachments in project
get
submittals
Get all submittals in project
get
Create a new submittal
post
Get submittal by ID
get
Delete submittal by ID
del
Update submittal
patch
Transition submittal to next state
patch
Import new submittals
post
submittal types
Get all submittal types
get
submittal watchers
Get all submittal_watchers in project
get
task attributes
Get all task_attributes in project
get
Get task_attribute by ID
get
Update task_attribute by ID
patch
Get all task attributes in task
get
Create a task attribute in task
post
Get a task attribute in task
get
Update a task attribute in task
patch
task check items
Get all task_check_items in project
get
Get task_check_item by ID
get
Update task_check_item by ID
patch
Delete task_check_item by ID
del
Show all task check items
get
Create a new task check item
post
Create several task check items at once
post
task relations
Get all task_relations in project
get
Create a new task_relation
post
Get task_relation by ID
get
Delete task_relation by ID
del
tasks
Get all tasks in project
get
Create a new task
post
Get task by ID
get
Delete task by ID
del
Update task by ID
patch
Restore task by ID
put
Duplicates a task by ID
post
Mark a checklist item checked in the Task
get
Get number of watched tasks, tasks per floorplan, and tasks per team
get
Find tasks that were updated to a status during start_date and end_date
get
Gets tags associated with the Task
get
Send an email containing a task's details with a custom body
post
Export a Task
post
Return related tasks
get
Get all Tasks
get
Create a new task
post
task type attributes
Get all task_type_attributes in project
get
Get all task type attributes in a task type
get
Create a task type attribute for a project
post
Get a task type attribute in a task type
get
Update a task type attribute in a task type
patch
Reorder task_type_attributes
put
Get count of tasks with task type attribute in project
get
tasks forms
Get all tasks_forms in project
get
Create a new tasks_form
post
Get tasks_form by ID
get
Update tasks_form by ID
patch
Delete tasks_form by ID
del
Restore tasks_form by ID
put
teams
Get all teams in project
get
Create a new team
post
Get team by ID
get
Update team by ID
patch
Delete team by ID
del
template check item
Get TemplateCheckItem by ID in project
get
Update template_check_item by ID
patch
Delete template_check_item by ID
del
Get all TemplateCheckItems in project
get
Get all template check items in a TemplateCheckList
get
Create a new template check items
post
Delete an existing active template check item
del
Update active template check items
put
[Deprecated] Batch create template check items
post
Delete existing active template check item(s)
del
Batch create template check items
post
template checklists
Get all template_checklists in project
get
Create a new template_checklist
post
Get template_checklist by ID
get
Update template_checklist by ID
patch
Delete template_checklist by ID
del
time
Show current time in Fieldwire server
get
weather conditions
Get all weather_conditions in project
get
Create a new weather_condition
post
Get weather_condition by ID
get
Update weather_condition by ID
patch
Delete weather_condition by ID
del
Restore weather_condition by ID
put
••••••53a5
Endpoint
Method
Status
User Agent
