Fieldwire MCP by usefulapi
Read Fieldwire projects, tasks, plans, forms, RFIs and submittals; create and update tasks.
Should I use this
Quality & Safety
Findings (1)
- LOWin fieldwire_list_task_check_items
Based on automated analysis of tool definitions and protocol compliance.
Context Cost
This is the approximate number of tokens consumed each time the server's tools are loaded into a model's context. Higher counts reduce the attention available for other tasks.
Install
One-Click Install
Add this to your `claude_desktop_config.json` file:
{
"mcpServers": {
"fieldwire": {
"url": "https://fieldwire.usefulapi.io/mcp"
}
}
}Remote endpoints
https://fieldwire.usefulapi.io/mcpstreamable-httpWhat it can do
Tool inventory
Tools (22)
🟢fieldwire_get_account
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.
Input Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢fieldwire_list_account_users
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.
Input Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢fieldwire_list_projects(name_contains, code, archived, updated_after, updated_before, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"name_contains": {
"description": "Only projects whose name contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"code": {
"description": "Only the project with this exact project code.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"archived": {
"description": "true = only archived projects, false = only unarchived.",
"type": "boolean"
},
"updated_after": {
"description": "Only projects updated at or after this ISO 8601 date-time.",
"type": "string"
},
"updated_before": {
"description": "Only projects updated at or before this ISO 8601 date-time.",
"type": "string"
},
"state": {
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header.",
"type": "string",
"enum": [
"active",
"deleted"
]
},
"per_page": {
"description": "Results per page, 1-200 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 200
},
"last_synced_at": {
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page.",
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢fieldwire_get_project(project_id)
One project by id: name, code, address, time zone, currency, plan, enabled features and owner email. GET /api/v3/projects/{id}.
Input Schema
{
"type": "object",
"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."
}
},
"required": [
"project_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢fieldwire_list_project_users(project_id, email_contains, first_name_contains, last_name_contains, company_contains)
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.
Input Schema
{
"type": "object",
"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": {
"description": "Only users whose email contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"first_name_contains": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"last_name_contains": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"company_contains": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"project_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢fieldwire_list_tasks(project_id, status_id, team_id, location_id, floorplan_id, ...)
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.
Input Schema
{
"type": "object",
"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."
},
"status_id": {
"description": "Only tasks with this 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}$"
},
"team_id": {
"description": "Only tasks of this team (shown as 'category' in the Fieldwire app).",
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"location_id": {
"description": "Only tasks at this location.",
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"floorplan_id": {
"description": "Only tasks pinned on this plan (floorplan).",
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"owner_user_id": {
"description": "Only tasks owned by this user id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"creator_user_id": {
"description": "Only tasks created by this user id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"name_contains": {
"description": "Only tasks whose name contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"tag": {
"description": "Only tasks with exactly this tag.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"due_after": {
"description": "Only tasks due on or after this date (yyyy-mm-dd) or date-time.",
"type": "string"
},
"due_before": {
"description": "Only tasks due on or before this date (yyyy-mm-dd) or date-time.",
"type": "string"
},
"created_after": {
"description": "Only tasks created at or after this ISO 8601 date-time.",
"type": "string"
},
"created_before": {
"description": "Only tasks created at or before this ISO 8601 date-time.",
"type": "string"
},
"updated_after": {
"description": "Only tasks updated at or after this ISO 8601 date-time.",
"type": "string"
},
"updated_before": {
"description": "Only tasks updated at or before this ISO 8601 date-time.",
"type": "string"
},
"state": {
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header.",
"type": "string",
"enum": [
"active",
"deleted"
]
},
"per_page": {
"description": "Results per page, 1-200 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 200
},
"last_synced_at": {
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page.",
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$"
}
},
"required": [
"project_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢fieldwire_get_task(project_id, task_id)
One task by id with all its fields. GET /api/v3/projects/{project_id}/tasks/{id}.
Input Schema
{
"type": "object",
"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."
},
"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)."
}
},
"required": [
"project_id",
"task_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢fieldwire_list_task_statuses(project_id)
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.
Input Schema
{
"type": "object",
"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."
}
},
"required": [
"project_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢fieldwire_list_teams(project_id, state, per_page, last_synced_at)
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.
Input Schema
{
"type": "object",
"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."
},
"state": {
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header.",
"type": "string",
"enum": [
"active",
"deleted"
]
},
"per_page": {
"description": "Results per page, 1-200 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 200
},
"last_synced_at": {
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page.",
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$"
}
},
"required": [
"project_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢fieldwire_list_locations(project_id, state, per_page, last_synced_at)
Locations of a project (id, name, parent location_id). Tasks carry a location_id. GET /api/v3/projects/{project_id}/locations.
Input Schema
{
"type": "object",
"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."
},
"state": {
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header.",
"type": "string",
"enum": [
"active",
"deleted"
]
},
"per_page": {
"description": "Results per page, 1-200 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 200
},
"last_synced_at": {
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page.",
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$"
}
},
"required": [
"project_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢fieldwire_list_task_check_items(project_id, state, per_page, last_synced_at)
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.
Input Schema
{
"type": "object",
"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."
},
"state": {
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header.",
"type": "string",
"enum": [
"active",
"deleted"
]
},
"per_page": {
"description": "Results per page, 1-200 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 200
},
"last_synced_at": {
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page.",
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$"
}
},
"required": [
"project_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢fieldwire_list_floorplans(project_id, name_contains, tag, with_current_sheet, updated_after, ...)
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.
Input Schema
{
"type": "object",
"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."
},
"name_contains": {
"description": "Only plans whose name contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"tag": {
"description": "Only plans with exactly this tag.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"with_current_sheet": {
"description": "Include the current sheet of each plan.",
"type": "boolean"
},
"updated_after": {
"description": "Only plans updated at or after this ISO 8601 date-time.",
"type": "string"
},
"state": {
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header.",
"type": "string",
"enum": [
"active",
"deleted"
]
},
"per_page": {
"description": "Results per page, 1-200 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 200
},
"last_synced_at": {
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page.",
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$"
}
},
"required": [
"project_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢fieldwire_list_sheets(project_id, floorplan_id, folder_id, name_contains, updated_after, ...)
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.
Input Schema
{
"type": "object",
"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."
},
"floorplan_id": {
"description": "Only sheets of this plan.",
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"folder_id": {
"description": "Only sheets in this folder.",
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"name_contains": {
"description": "Only sheets whose name contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"updated_after": {
"description": "Only sheets updated at or after this ISO 8601 date-time.",
"type": "string"
},
"state": {
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header.",
"type": "string",
"enum": [
"active",
"deleted"
]
},
"per_page": {
"description": "Results per page, 1-200 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 200
},
"last_synced_at": {
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page.",
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$"
}
},
"required": [
"project_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢fieldwire_list_attachments(project_id, kind, state, per_page, last_synced_at)
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.
Input Schema
{
"type": "object",
"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."
},
"kind": {
"description": "Only these kinds.",
"minItems": 1,
"maxItems": 5,
"type": "array",
"items": {
"type": "string",
"enum": [
"file",
"photo",
"photo_sphere",
"video",
"sign"
]
}
},
"state": {
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header.",
"type": "string",
"enum": [
"active",
"deleted"
]
},
"per_page": {
"description": "Results per page, 1-200 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 200
},
"last_synced_at": {
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page.",
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$"
}
},
"required": [
"project_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢fieldwire_list_forms(project_id, form_template_id, owner_user_id, name_contains, due_after, ...)
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.
Input Schema
{
"type": "object",
"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."
},
"form_template_id": {
"description": "Only forms made from this template (see fieldwire_list_form_templates).",
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"owner_user_id": {
"description": "Only forms owned by this user id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"name_contains": {
"description": "Only forms whose name contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"due_after": {
"description": "Only forms due on or after this date or date-time.",
"type": "string"
},
"due_before": {
"description": "Only forms due on or before this date or date-time.",
"type": "string"
},
"updated_after": {
"description": "Only forms updated at or after this ISO 8601 date-time.",
"type": "string"
},
"state": {
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header.",
"type": "string",
"enum": [
"active",
"deleted"
]
},
"per_page": {
"description": "Results per page, 1-200 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 200
},
"last_synced_at": {
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page.",
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$"
}
},
"required": [
"project_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢fieldwire_get_form(project_id, form_id)
One form by id (header data only, not the filled-in values). GET /api/v3/projects/{project_id}/forms/{id}.
Input Schema
{
"type": "object",
"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."
},
"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)."
}
},
"required": [
"project_id",
"form_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢fieldwire_get_form_full(project_id, form_id, jid)
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.
Input Schema
{
"type": "object",
"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."
},
"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)."
},
"jid": {
"description": "The jid returned by the first call; leave out to start.",
"type": "string",
"pattern": "^[0-9A-Za-z-]{8,64}$"
}
},
"required": [
"project_id",
"form_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢fieldwire_list_form_templates(project_id, name_contains, state, per_page, last_synced_at)
Form templates of a project: id, name, version, publish state. Use the id to filter forms. GET /api/v3/projects/{project_id}/form_templates.
Input Schema
{
"type": "object",
"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."
},
"name_contains": {
"description": "Only templates whose name contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"state": {
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header.",
"type": "string",
"enum": [
"active",
"deleted"
]
},
"per_page": {
"description": "Results per page, 1-200 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 200
},
"last_synced_at": {
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page.",
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$"
}
},
"required": [
"project_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢fieldwire_list_rfis(project_id, status, assignee_user_id, text, overdue, ...)
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.
Input Schema
{
"type": "object",
"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."
},
"status": {
"description": "Only RFIs with this status.",
"type": "string",
"enum": [
"draft",
"submitted",
"answered",
"closed",
"void"
]
},
"assignee_user_id": {
"description": "Only RFIs assigned to this user id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"text": {
"description": "Free-text search.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"overdue": {
"description": "true = only overdue RFIs.",
"type": "boolean"
},
"updated_after": {
"description": "Only RFIs updated at or after this ISO 8601 date-time.",
"type": "string"
},
"state": {
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header.",
"type": "string",
"enum": [
"active",
"deleted"
]
},
"per_page": {
"description": "Results per page, 1-200 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 200
},
"last_synced_at": {
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page.",
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$"
}
},
"required": [
"project_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢fieldwire_list_submittals(project_id, status, assignee_user_id, text, overdue, ...)
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.
Input Schema
{
"type": "object",
"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."
},
"status": {
"description": "Only submittals with this status.",
"type": "string",
"enum": [
"draft",
"requested",
"pending_review",
"pending_approval",
"pending_close",
"closed",
"void"
]
},
"assignee_user_id": {
"description": "Only submittals assigned to this user id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"text": {
"description": "Free-text search.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"overdue": {
"description": "true = only overdue submittals.",
"type": "boolean"
},
"updated_after": {
"description": "Only submittals updated at or after this ISO 8601 date-time.",
"type": "string"
},
"state": {
"description": "Only active records (the usual) or only deleted ones. Sent as the Fieldwire-Filter header.",
"type": "string",
"enum": [
"active",
"deleted"
]
},
"per_page": {
"description": "Results per page, 1-200 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 200
},
"last_synced_at": {
"description": "Cursor for the next page: the previous reply's next_last_synced_at, unchanged. Leave out for the first page.",
"type": "string",
"pattern": "^[0-9A-Za-z:.+\\- ]{10,64}$"
}
},
"required": [
"project_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡fieldwire_create_task(project_id, name, status_id, team_id, location_id, ...)
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.
Input Schema
{
"type": "object",
"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."
},
"name": {
"description": "Task name.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"status_id": {
"description": "Status id - see fieldwire_list_task_statuses.",
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"team_id": {
"description": "Team (category) id - see fieldwire_list_teams.",
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"location_id": {
"description": "Location id - see fieldwire_list_locations.",
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"floorplan_id": {
"description": "Plan (floorplan) id the task belongs to - see fieldwire_list_floorplans.",
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"owner_user_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "User id of the task owner (required) - see fieldwire_list_project_users."
},
"user_ids": {
"description": "User ids of the assignees. On an update this REPLACES the whole assignee list.",
"maxItems": 50,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"priority": {
"type": "integer",
"minimum": 1,
"maximum": 3,
"description": "Priority 1, 2 or 3 (Fieldwire's own values; required)."
},
"due_date": {
"description": "Due date, yyyy-mm-dd.",
"type": "string"
},
"start_at": {
"description": "Start, ISO 8601 date-time with a timezone.",
"type": "string"
},
"end_at": {
"description": "End, ISO 8601 date-time with a timezone.",
"type": "string"
},
"cost_value": {
"description": "Cost of the task.",
"type": "number",
"minimum": 0
},
"man_power_value": {
"description": "Estimated man-power (hours, days or months as set in the project).",
"type": "number",
"minimum": 0
},
"creator_user_id": {
"description": "User id recorded as creator (default: the owner).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"project_id",
"owner_user_id",
"priority"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴fieldwire_update_task(project_id, task_id, name, status_id, team_id, ...)
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}.
Input Schema
{
"type": "object",
"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."
},
"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)."
},
"name": {
"description": "Task name; null removes it.",
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 200
},
{
"type": "null"
}
]
},
"status_id": {
"description": "Status id - see fieldwire_list_task_statuses; null removes the status.",
"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"
}
]
},
"team_id": {
"description": "Team (category) id; null removes the team.",
"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"
}
]
},
"location_id": {
"description": "Location id; null removes the location.",
"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"
}
]
},
"floorplan_id": {
"description": "Plan (floorplan) id; null removes the plan.",
"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"
}
]
},
"owner_user_id": {
"description": "User id of the task owner - see fieldwire_list_project_users.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"user_ids": {
"description": "User ids of the assignees. REPLACES the whole assignee list; null removes all assignees.",
"anyOf": [
{
"maxItems": 50,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
{
"type": "null"
}
]
},
"priority": {
"description": "Priority 1, 2 or 3 (Fieldwire's own values).",
"type": "integer",
"minimum": 1,
"maximum": 3
},
"due_date": {
"description": "Due date, yyyy-mm-dd; null removes the due date.",
"type": [
"string",
"null"
]
},
"start_at": {
"description": "Start, ISO 8601 date-time with a timezone; null removes it.",
"type": [
"string",
"null"
]
},
"end_at": {
"description": "End, ISO 8601 date-time with a timezone; null removes it.",
"type": [
"string",
"null"
]
},
"cost_value": {
"description": "Cost of the task; null removes it.",
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"man_power_value": {
"description": "Estimated man-power; null removes it.",
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
}
},
"required": [
"project_id",
"task_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Community
Evidence