Read Fieldwire projects, tasks, plans, forms, RFIs and submittals; create and update tasks.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
WRITE: creates a new task in a project. It is sent once and never retried; if the reply is an error, check fieldwire_list_tasks before creating it again, or you may get a duplicate. owner_user_id and priority are required; creator_user_id defaults to the owner. Find user ids with fieldwire_list_project_users. POST /api/v3/projects/{project_id}/tasks.
Priority 1, 2 or 3 (Fieldwire's own values; required).
Fieldwire project id (UUID) - see fieldwire_list_projects.
User id of the task owner (required) - see fieldwire_list_project_users.
Task name.
End, ISO 8601 date-time with a timezone.
Team (category) id - see fieldwire_list_teams.
Due date, yyyy-mm-dd.
Start, ISO 8601 date-time with a timezone.
User ids of the assignees. On an update this REPLACES the whole assignee list.
Status id - see fieldwire_list_task_statuses.
Cost of the task.
Location id - see fieldwire_list_locations.
Plan (floorplan) id the task belongs to - see fieldwire_list_floorplans.
User id recorded as creator (default: the owner).
Estimated man-power (hours, days or months as set in the project).
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
WRITE: creates a new task in a project. It is sent once and never retried; if the reply is an error, check fieldwire_list_tasks before creating it again, or you may get a duplicate. owner_user_id and priority are required; creator_user_id defaults to the owner. Find user ids with fieldwire_list_project_users. POST /api/v3/projects/{project_id}/tasks.
| Argument | Type | Description |
|---|---|---|
| name | string | Task name. |
| end_at | string | End, ISO 8601 date-time with a timezone. |
| team_id | string | Team (category) id - see fieldwire_list_teams. |
| due_date | string | Due date, yyyy-mm-dd. |
| priority* | integer | Priority 1, 2 or 3 (Fieldwire's own values; required). |
| start_at | string | Start, ISO 8601 date-time with a timezone. |
| user_ids | array | User ids of the assignees. On an update this REPLACES the whole assignee list. |
| status_id | string | Status id - see fieldwire_list_task_statuses. |
| cost_value | number | Cost of the task. |
| project_id* | string | Fieldwire project id (UUID) - see fieldwire_list_projects. |
| location_id | string | Location id - see fieldwire_list_locations. |
| floorplan_id | string | Plan (floorplan) id the task belongs to - see fieldwire_list_floorplans. |
| owner_user_id* | integer | User id of the task owner (required) - see fieldwire_list_project_users. |
| creator_user_id | integer | User id recorded as creator (default: the owner). |
| man_power_value | number | Estimated man-power (hours, days or months as set in the project). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project_id",
"owner_user_id",
"priority"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Task name."
},
"end_at": {
"type": "string",
"description": "End, ISO 8601 date-time with a timezone."
},
"team_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Team (category) id - see fieldwire_list_teams."
},
"due_date": {
"type": "string",
"description": "Due date, yyyy-mm-dd."
},
"priority": {
"type": "integer",
"maximum": 3,
"minimum": 1,
"description": "Priority 1, 2 or 3 (Fieldwire's own values; required)."
},
"start_at": {
"type": "string",
"description": "Start, ISO 8601 date-time with a timezone."
},
"user_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 50,
"description": "User ids of the assignees. On an update this REPLACES the whole assignee list."
},
"status_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Status id - see fieldwire_list_task_statuses."
},
"cost_value": {
"type": "number",
"minimum": 0,
"description": "Cost of the task."
},
"project_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Fieldwire project id (UUID) - see fieldwire_list_projects."
},
"location_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Location id - see fieldwire_list_locations."
},
"floorplan_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Plan (floorplan) id the task belongs to - see fieldwire_list_floorplans."
},
"owner_user_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "User id of the task owner (required) - see fieldwire_list_project_users.",
"exclusiveMinimum": 0
},
"creator_user_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "User id recorded as creator (default: the owner).",
"exclusiveMinimum": 0
},
"man_power_value": {
"type": "number",
"minimum": 0,
"description": "Estimated man-power (hours, days or months as set in the project)."
}
}
}The Fieldwire account this API token belongs to: id, company name and address, enabled modules (submittals, change orders, RFIs, specs, BIM) and the owner. GET /account on the account host.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}One form by id (header data only, not the filled-in values). GET /api/v3/projects/{project_id}/forms/{id}.
| Argument | Type | Description |
|---|---|---|
| form_id* | string | Form id (UUID). |
| project_id* | string | Fieldwire project id (UUID) - see fieldwire_list_projects. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project_id",
"form_id"
],
"properties": {
"form_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Form id (UUID)."
},
"project_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Fieldwire project id (UUID) - see fieldwire_list_projects."
}
}
}A form with its sections, inputs and filled-in values. Two steps: call without jid to start the job (Fieldwire answers with a jid); then call again with that jid until the form comes back (answer 'pending' means not ready, retry). GET /api/v3/projects/{project_id}/forms/{id}/full.
| Argument | Type | Description |
|---|---|---|
| jid | string | The jid returned by the first call; leave out to start. |
| form_id* | string | Form id (UUID). |
| project_id* | string | Fieldwire project id (UUID) - see fieldwire_list_projects. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project_id",
"form_id"
],
"properties": {
"jid": {
"type": "string",
"pattern": "^[0-9A-Za-z-]{8,64}$",
"description": "The jid returned by the first call; leave out to start."
},
"form_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Form id (UUID)."
},
"project_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Fieldwire project id (UUID) - see fieldwire_list_projects."
}
}
}One project by id: name, code, address, time zone, currency, plan, enabled features and owner email. GET /api/v3/projects/{id}.
| Argument | Type | Description |
|---|---|---|
| project_id* | string | Fieldwire project id (UUID) - see fieldwire_list_projects. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project_id"
],
"properties": {
"project_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Fieldwire project id (UUID) - see fieldwire_list_projects."
}
}
}One task by id with all its fields. GET /api/v3/projects/{project_id}/tasks/{id}.
| Argument | Type | Description |
|---|---|---|
| task_id* | string | Task id (UUID). |
| project_id* | string | Fieldwire project id (UUID) - see fieldwire_list_projects. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project_id",
"task_id"
],
"properties": {
"task_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Task id (UUID)."
},
"project_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Fieldwire project id (UUID) - see fieldwire_list_projects."
}
}
}All users on the account (and users invited to its projects) with name, company, email, account role and the number of projects each is in. User ids are what tasks use for owner and assignees. GET /account/users on the account host.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Files, photos, videos and 360 photos attached in a project: id, name, kind, size, capture time and file URLs. Filter by kind. GET /api/v3/projects/{project_id}/attachments.
| Argument | Type | Description |
|---|---|---|
| kind | array | Only these kinds. |
| state | string | Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header. |
| per_page | integer | Results per page, 1-200 (default 25). |
| project_id* | string | Fieldwire project id (UUID) - see fieldwire_list_projects. |
| last_synced_at | string | Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project_id"
],
"properties": {
"kind": {
"type": "array",
"items": {
"enum": [
"file",
"photo",
"photo_sphere",
"video",
"sign"
],
"type": "string"
},
"maxItems": 5,
"minItems": 1,
"description": "Only these kinds."
},
"state": {
"enum": [
"active",
"deleted"
],
"type": "string",
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header."
},
"per_page": {
"type": "integer",
"maximum": 200,
"description": "Results per page, 1-200 (default 25).",
"exclusiveMinimum": 0
},
"project_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Fieldwire project id (UUID) - see fieldwire_list_projects."
},
"last_synced_at": {
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$",
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page."
}
}
}Plans (floorplans) of a project: id, name, description, folder and sheet count. Filter by name, tag or dates. Set with_current_sheet to include each plan's current sheet. GET /api/v3/projects/{project_id}/floorplans.
| Argument | Type | Description |
|---|---|---|
| tag | string | Only plans with exactly this tag. |
| state | string | Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header. |
| per_page | integer | Results per page, 1-200 (default 25). |
| project_id* | string | Fieldwire project id (UUID) - see fieldwire_list_projects. |
| name_contains | string | Only plans whose name contains this text. |
| updated_after | string | Only plans updated at or after this ISO 8601 date-time. |
| last_synced_at | string | Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page. |
| with_current_sheet | boolean | Include the current sheet of each plan. |
Form templates of a project: id, name, version, publish state. Use the id to filter forms. GET /api/v3/projects/{project_id}/form_templates.
| Argument | Type | Description |
|---|---|---|
| state | string | Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header. |
| per_page | integer | Results per page, 1-200 (default 25). |
| project_id* | string | Fieldwire project id (UUID) - see fieldwire_list_projects. |
| name_contains | string | Only templates whose name contains this text. |
| last_synced_at | string | Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project_id"
],
"properties": {
"state": {
"enum": [
"active",
"deleted"
],
"type": "string",
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header."
},
"per_page": {
"type": "integer",
"maximum": 200,
"description": "Results per page, 1-200 (default 25).",
"exclusiveMinimum": 0
},
"project_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Fieldwire project id (UUID) - see fieldwire_list_projects."
},
"name_contains": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only templates whose name contains this text."
},
"last_synced_at": {
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$",
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page."
}
}
}Forms (inspections, daily reports, checklists) of a project: id, name, template, status, owner, dates. Forms need a Business plan. Use fieldwire_get_form_full for the filled-in values. GET /api/v3/projects/{project_id}/forms.
| Argument | Type | Description |
|---|---|---|
| state | string | Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header. |
| per_page | integer | Results per page, 1-200 (default 25). |
| due_after | string | Only forms due on or after this date or date-time. |
| due_before | string | Only forms due on or before this date or date-time. |
| project_id* | string | Fieldwire project id (UUID) - see fieldwire_list_projects. |
| name_contains | string | Only forms whose name contains this text. |
| owner_user_id | integer | Only forms owned by this user id. |
| updated_after | string | Only forms updated at or after this ISO 8601 date-time. |
Locations of a project (id, name, parent location_id). Tasks carry a location_id. GET /api/v3/projects/{project_id}/locations.
| Argument | Type | Description |
|---|---|---|
| state | string | Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header. |
| per_page | integer | Results per page, 1-200 (default 25). |
| project_id* | string | Fieldwire project id (UUID) - see fieldwire_list_projects. |
| last_synced_at | string | Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project_id"
],
"properties": {
"state": {
"enum": [
"active",
"deleted"
],
"type": "string",
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header."
},
"per_page": {
"type": "integer",
"maximum": 200,
"description": "Results per page, 1-200 (default 25).",
"exclusiveMinimum": 0
},
"project_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Fieldwire project id (UUID) - see fieldwire_list_projects."
},
"last_synced_at": {
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$",
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page."
}
}
}Users on one project with name, company, job title, email and phone. The integer id is what tasks use for owner_user_id and user_ids. Filter by email, name or company. GET /api/v3/account/projects/{project_id}/users.
| Argument | Type | Description |
|---|---|---|
| project_id* | string | Fieldwire project id (UUID) - see fieldwire_list_projects. |
| email_contains | string | Only users whose email contains this text. |
| company_contains | string | |
| last_name_contains | string | |
| first_name_contains | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project_id"
],
"properties": {
"project_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Fieldwire project id (UUID) - see fieldwire_list_projects."
},
"email_contains": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only users whose email contains this text."
},
"company_contains": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"last_name_contains": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"first_name_contains": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
}
}Projects the token's user can access in the region chosen at login: id, name, code, address, time zone, plan and archive state. Filter by name, code, archive state or update time. Use the id in every other tool. GET /api/v3/projects.
| Argument | Type | Description |
|---|---|---|
| code | string | Only the project with this exact project code. |
| state | string | Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header. |
| archived | boolean | true = only archived projects, false = only unarchived. |
| per_page | integer | Results per page, 1-200 (default 25). |
| name_contains | string | Only projects whose name contains this text. |
| updated_after | string | Only projects updated at or after this ISO 8601 date-time. |
| last_synced_at | string | Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page. |
| updated_before | string | Only projects updated at or before this ISO 8601 date-time. |
RFIs (requests for information) of a project: number, name, question, answer, status, assignee, due date. Needs the RFI module. Filter by status, assignee, text, overdue or dates. GET /api/v3/projects/{project_id}/rfis.
| Argument | Type | Description |
|---|---|---|
| text | string | Free-text search. |
| state | string | Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header. |
| status | string | Only RFIs with this status. |
| overdue | boolean | true = only overdue RFIs. |
| per_page | integer | Results per page, 1-200 (default 25). |
| project_id* | string | Fieldwire project id (UUID) - see fieldwire_list_projects. |
| updated_after | string | Only RFIs updated at or after this ISO 8601 date-time. |
| last_synced_at | string | Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page. |
Sheets (plan versions) of a project: id, name, file name, version, floorplan_id and file URLs. Filter by plan, folder, name or dates. GET /api/v3/projects/{project_id}/sheets.
| Argument | Type | Description |
|---|---|---|
| state | string | Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header. |
| per_page | integer | Results per page, 1-200 (default 25). |
| folder_id | string | Only sheets in this folder. |
| project_id* | string | Fieldwire project id (UUID) - see fieldwire_list_projects. |
| floorplan_id | string | Only sheets of this plan. |
| name_contains | string | Only sheets whose name contains this text. |
| updated_after | string | Only sheets updated at or after this ISO 8601 date-time. |
| last_synced_at | string | Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page. |
Submittals of a project: number, name, status, revision, key dates. Needs the submittals module. Filter by status, assignee, text, overdue or dates. GET /api/v3/projects/{project_id}/submittals.
| Argument | Type | Description |
|---|---|---|
| text | string | Free-text search. |
| state | string | Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header. |
| status | string | Only submittals with this status. |
| overdue | boolean | true = only overdue submittals. |
| per_page | integer | Results per page, 1-200 (default 25). |
| project_id* | string | Fieldwire project id (UUID) - see fieldwire_list_projects. |
| updated_after | string | Only submittals updated at or after this ISO 8601 date-time. |
| last_synced_at | string | Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page. |
Checklist items of all tasks in a project: name, checked flag, state (empty/yes/no/not_applicable) and task_id (match it to the task). GET /api/v3/projects/{project_id}/task_check_items.
| Argument | Type | Description |
|---|---|---|
| state | string | Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header. |
| per_page | integer | Results per page, 1-200 (default 25). |
| project_id* | string | Fieldwire project id (UUID) - see fieldwire_list_projects. |
| last_synced_at | string | Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project_id"
],
"properties": {
"state": {
"enum": [
"active",
"deleted"
],
"type": "string",
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header."
},
"per_page": {
"type": "integer",
"maximum": 200,
"description": "Results per page, 1-200 (default 25).",
"exclusiveMinimum": 0
},
"project_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Fieldwire project id (UUID) - see fieldwire_list_projects."
},
"last_synced_at": {
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$",
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page."
}
}
}The task statuses of a project (id, name, order, kind open/tracked/verified, default flag). Use the id as status_id on tasks. GET /api/v3/projects/{project_id}/statuses.
| Argument | Type | Description |
|---|---|---|
| project_id* | string | Fieldwire project id (UUID) - see fieldwire_list_projects. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project_id"
],
"properties": {
"project_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Fieldwire project id (UUID) - see fieldwire_list_projects."
}
}
}Tasks (punch items, issues) in a project: name, status_id, team_id, location_id, floorplan_id, owner and assignee user ids, priority, dates and cost. Filter by status, team, location, plan, owner, name, tag and dates. Resolve ids with fieldwire_list_task_statuses, _list_teams, _list_locations and _list_project_users. GET /api/v3/projects/{project_id}/tasks.
| Argument | Type | Description |
|---|---|---|
| tag | string | Only tasks with exactly this tag. |
| state | string | Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header. |
| team_id | string | Only tasks of this team (shown as 'category' in the Fieldwire app). |
| per_page | integer | Results per page, 1-200 (default 25). |
| due_after | string | Only tasks due on or after this date (yyyy-mm-dd) or date-time. |
| status_id | string | Only tasks with this status id. |
| due_before | string | Only tasks due on or before this date (yyyy-mm-dd) or date-time. |
| project_id* | string |
Teams of a project (id, name, handle). The Fieldwire app calls them 'categories' on tasks; tasks carry a team_id. GET /api/v3/projects/{project_id}/teams.
| Argument | Type | Description |
|---|---|---|
| state | string | Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header. |
| per_page | integer | Results per page, 1-200 (default 25). |
| project_id* | string | Fieldwire project id (UUID) - see fieldwire_list_projects. |
| last_synced_at | string | Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project_id"
],
"properties": {
"state": {
"enum": [
"active",
"deleted"
],
"type": "string",
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header."
},
"per_page": {
"type": "integer",
"maximum": 200,
"description": "Results per page, 1-200 (default 25).",
"exclusiveMinimum": 0
},
"project_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Fieldwire project id (UUID) - see fieldwire_list_projects."
},
"last_synced_at": {
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$",
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page."
}
}
}WRITE: changes fields of one task (only the fields you pass; user_ids replaces the whole assignee list; null clears a field that allows it). Use it to set the status, owner, assignees, priority or dates. It does not delete the task. Sent once, never retried. PATCH /api/v3/projects/{project_id}/tasks/{id}.
| Argument | Type | Description |
|---|---|---|
| name | any | Task name; null removes it. |
| end_at | string | null | End, ISO 8601 date-time with a timezone; null removes it. |
| task_id* | string | Task id (UUID). |
| team_id | any | Team (category) id; null removes the team. |
| due_date | string | null | Due date, yyyy-mm-dd; null removes the due date. |
| priority | integer | Priority 1, 2 or 3 (Fieldwire's own values). |
| start_at | string | null | Start, ISO 8601 date-time with a timezone; null removes it. |
| user_ids | any | User ids of the assignees. REPLACES the whole assignee list; null removes all assignees. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project_id"
],
"properties": {
"tag": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only plans with exactly this tag."
},
"state": {
"enum": [
"active",
"deleted"
],
"type": "string",
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header."
},
"per_page": {
"type": "integer",
"maximum": 200,
"description": "Results per page, 1-200 (default 25).",
"exclusiveMinimum": 0
},
"project_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Fieldwire project id (UUID) - see fieldwire_list_projects."
},
"name_contains": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only plans whose name contains this text."
},
"updated_after": {
"type": "string",
"description": "Only plans updated at or after this ISO 8601 date-time."
},
"last_synced_at": {
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$",
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page."
},
"with_current_sheet": {
"type": "boolean",
"description": "Include the current sheet of each plan."
}
}
}| last_synced_at | string | Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page. |
| form_template_id | string | Only forms made from this template (see fieldwire_list_form_templates). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project_id"
],
"properties": {
"state": {
"enum": [
"active",
"deleted"
],
"type": "string",
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header."
},
"per_page": {
"type": "integer",
"maximum": 200,
"description": "Results per page, 1-200 (default 25).",
"exclusiveMinimum": 0
},
"due_after": {
"type": "string",
"description": "Only forms due on or after this date or date-time."
},
"due_before": {
"type": "string",
"description": "Only forms due on or before this date or date-time."
},
"project_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Fieldwire project id (UUID) - see fieldwire_list_projects."
},
"name_contains": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only forms whose name contains this text."
},
"owner_user_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only forms owned by this user id.",
"exclusiveMinimum": 0
},
"updated_after": {
"type": "string",
"description": "Only forms updated at or after this ISO 8601 date-time."
},
"last_synced_at": {
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$",
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page."
},
"form_template_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Only forms made from this template (see fieldwire_list_form_templates)."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"code": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only the project with this exact project code."
},
"state": {
"enum": [
"active",
"deleted"
],
"type": "string",
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header."
},
"archived": {
"type": "boolean",
"description": "true = only archived projects, false = only unarchived."
},
"per_page": {
"type": "integer",
"maximum": 200,
"description": "Results per page, 1-200 (default 25).",
"exclusiveMinimum": 0
},
"name_contains": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only projects whose name contains this text."
},
"updated_after": {
"type": "string",
"description": "Only projects updated at or after this ISO 8601 date-time."
},
"last_synced_at": {
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$",
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page."
},
"updated_before": {
"type": "string",
"description": "Only projects updated at or before this ISO 8601 date-time."
}
}
}| assignee_user_id |
| integer |
| Only RFIs assigned to this user id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project_id"
],
"properties": {
"text": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Free-text search."
},
"state": {
"enum": [
"active",
"deleted"
],
"type": "string",
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header."
},
"status": {
"enum": [
"draft",
"submitted",
"answered",
"closed",
"void"
],
"type": "string",
"description": "Only RFIs with this status."
},
"overdue": {
"type": "boolean",
"description": "true = only overdue RFIs."
},
"per_page": {
"type": "integer",
"maximum": 200,
"description": "Results per page, 1-200 (default 25).",
"exclusiveMinimum": 0
},
"project_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Fieldwire project id (UUID) - see fieldwire_list_projects."
},
"updated_after": {
"type": "string",
"description": "Only RFIs updated at or after this ISO 8601 date-time."
},
"last_synced_at": {
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$",
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page."
},
"assignee_user_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only RFIs assigned to this user id.",
"exclusiveMinimum": 0
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project_id"
],
"properties": {
"state": {
"enum": [
"active",
"deleted"
],
"type": "string",
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header."
},
"per_page": {
"type": "integer",
"maximum": 200,
"description": "Results per page, 1-200 (default 25).",
"exclusiveMinimum": 0
},
"folder_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Only sheets in this folder."
},
"project_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Fieldwire project id (UUID) - see fieldwire_list_projects."
},
"floorplan_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Only sheets of this plan."
},
"name_contains": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only sheets whose name contains this text."
},
"updated_after": {
"type": "string",
"description": "Only sheets updated at or after this ISO 8601 date-time."
},
"last_synced_at": {
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$",
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page."
}
}
}| assignee_user_id |
| integer |
| Only submittals assigned to this user id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project_id"
],
"properties": {
"text": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Free-text search."
},
"state": {
"enum": [
"active",
"deleted"
],
"type": "string",
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header."
},
"status": {
"enum": [
"draft",
"requested",
"pending_review",
"pending_approval",
"pending_close",
"closed",
"void"
],
"type": "string",
"description": "Only submittals with this status."
},
"overdue": {
"type": "boolean",
"description": "true = only overdue submittals."
},
"per_page": {
"type": "integer",
"maximum": 200,
"description": "Results per page, 1-200 (default 25).",
"exclusiveMinimum": 0
},
"project_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Fieldwire project id (UUID) - see fieldwire_list_projects."
},
"updated_after": {
"type": "string",
"description": "Only submittals updated at or after this ISO 8601 date-time."
},
"last_synced_at": {
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$",
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page."
},
"assignee_user_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only submittals assigned to this user id.",
"exclusiveMinimum": 0
}
}
}| Fieldwire project id (UUID) - see fieldwire_list_projects. |
| location_id | string | Only tasks at this location. |
| floorplan_id | string | Only tasks pinned on this plan (floorplan). |
| created_after | string | Only tasks created at or after this ISO 8601 date-time. |
| name_contains | string | Only tasks whose name contains this text. |
| owner_user_id | integer | Only tasks owned by this user id. |
| updated_after | string | Only tasks updated at or after this ISO 8601 date-time. |
| created_before | string | Only tasks created at or before this ISO 8601 date-time. |
| last_synced_at | string | Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page. |
| updated_before | string | Only tasks updated at or before this ISO 8601 date-time. |
| creator_user_id | integer | Only tasks created by this user id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project_id"
],
"properties": {
"tag": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only tasks with exactly this tag."
},
"state": {
"enum": [
"active",
"deleted"
],
"type": "string",
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header."
},
"team_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Only tasks of this team (shown as 'category' in the Fieldwire app)."
},
"per_page": {
"type": "integer",
"maximum": 200,
"description": "Results per page, 1-200 (default 25).",
"exclusiveMinimum": 0
},
"due_after": {
"type": "string",
"description": "Only tasks due on or after this date (yyyy-mm-dd) or date-time."
},
"status_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Only tasks with this status id."
},
"due_before": {
"type": "string",
"description": "Only tasks due on or before this date (yyyy-mm-dd) or date-time."
},
"project_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Fieldwire project id (UUID) - see fieldwire_list_projects."
},
"location_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Only tasks at this location."
},
"floorplan_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Only tasks pinned on this plan (floorplan)."
},
"created_after": {
"type": "string",
"description": "Only tasks created at or after this ISO 8601 date-time."
},
"name_contains": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only tasks whose name contains this text."
},
"owner_user_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only tasks owned by this user id.",
"exclusiveMinimum": 0
},
"updated_after": {
"type": "string",
"description": "Only tasks updated at or after this ISO 8601 date-time."
},
"created_before": {
"type": "string",
"description": "Only tasks created at or before this ISO 8601 date-time."
},
"last_synced_at": {
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$",
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page."
},
"updated_before": {
"type": "string",
"description": "Only tasks updated at or before this ISO 8601 date-time."
},
"creator_user_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only tasks created by this user id.",
"exclusiveMinimum": 0
}
}
}| status_id | any | Status id - see fieldwire_list_task_statuses; null removes the status. |
| cost_value | any | Cost of the task; null removes it. |
| project_id* | string | Fieldwire project id (UUID) - see fieldwire_list_projects. |
| location_id | any | Location id; null removes the location. |
| floorplan_id | any | Plan (floorplan) id; null removes the plan. |
| owner_user_id | integer | User id of the task owner - see fieldwire_list_project_users. |
| man_power_value | any | Estimated man-power; null removes it. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project_id",
"task_id"
],
"properties": {
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 200,
"minLength": 1
},
{
"type": "null"
}
],
"description": "Task name; null removes it."
},
"end_at": {
"type": [
"string",
"null"
],
"description": "End, ISO 8601 date-time with a timezone; null removes it."
},
"task_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Task id (UUID)."
},
"team_id": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
{
"type": "null"
}
],
"description": "Team (category) id; null removes the team."
},
"due_date": {
"type": [
"string",
"null"
],
"description": "Due date, yyyy-mm-dd; null removes the due date."
},
"priority": {
"type": "integer",
"maximum": 3,
"minimum": 1,
"description": "Priority 1, 2 or 3 (Fieldwire's own values)."
},
"start_at": {
"type": [
"string",
"null"
],
"description": "Start, ISO 8601 date-time with a timezone; null removes it."
},
"user_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 50
},
{
"type": "null"
}
],
"description": "User ids of the assignees. REPLACES the whole assignee list; null removes all assignees."
},
"status_id": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
{
"type": "null"
}
],
"description": "Status id - see fieldwire_list_task_statuses; null removes the status."
},
"cost_value": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
],
"description": "Cost of the task; null removes it."
},
"project_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Fieldwire project id (UUID) - see fieldwire_list_projects."
},
"location_id": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
{
"type": "null"
}
],
"description": "Location id; null removes the location."
},
"floorplan_id": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
{
"type": "null"
}
],
"description": "Plan (floorplan) id; null removes the plan."
},
"owner_user_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "User id of the task owner - see fieldwire_list_project_users.",
"exclusiveMinimum": 0
},
"man_power_value": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
],
"description": "Estimated man-power; null removes it."
}
}
}