Choose the status described in the policy.
","description":"Safe canonical HTML for Field guidance. The supported reduced CKEditor markup is paragraphs, line breaks, bold (`strong`), italic (`em`), underline (`u`), strikethrough (`s`), and links (`a` with `href`)."},"type_metadata":{"nullable":true,"description":"Validation metadata for this Field. List Fields expose their current allowed `options`; other Field types return null.","type":"object","allOf":[{"$ref":"#/components/schemas/FormFieldTypeMetadata"}]},"created_at":{"type":"string","format":"date-time","example":"2026-02-01T12:30:00.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2026-03-10T12:30:00.000Z"}},"required":["uuid","name","type","sequence","guidance","type_metadata","created_at","updated_at"]},"FormFieldSortBy":{"type":"string","enum":["created_at","sequence"]},"FormValueUpdateRead":{"type":"object","properties":{"value":{"type":"string","description":"The Value exactly as stored. Formatted text is returned as stored HTML. This is null for image-backed Values.","nullable":true,"example":"Client acceptance response"},"file_uuid":{"type":"string","description":"The stored File UUID for an image-backed Value; otherwise null.","format":"uuid","nullable":true,"example":"7d50d252-be0c-4d69-b77a-5bbdfef83f55"},"created_at":{"type":"string","description":"When the Value was first stored.","format":"date-time","example":"2026-02-01T12:30:00.000Z"},"updated_at":{"type":"string","description":"When the stored Value was last changed.","format":"date-time","example":"2026-03-10T12:30:00.000Z"},"has_pending_track_changes":{"type":"boolean","description":"Whether this formatted-text Value has unresolved track-change suggestions.","nullable":false,"example":false},"field_uuid":{"type":"string","description":"The UUID of the Form Field whose Value was committed.","format":"uuid","example":"82de76c4-964b-4519-94cf-7ce6b6d409f7"}},"required":["value","file_uuid","created_at","updated_at","has_pending_track_changes","field_uuid"]},"FormValueTrackedChangesPolicy":{"type":"string","enum":["FAIL","DISCARD"],"description":"Controls unresolved tracked changes on targeted Values. Defaults to FAIL when omitted. FAIL rejects the entire batch. DISCARD rejects unresolved suggestions atomically before replacing the Values."},"FormValueUpdateItem":{"type":"object","properties":{"field_uuid":{"type":"string","description":"The UUID of the Form Field whose Value to set or clear.","format":"uuid","example":"82de76c4-964b-4519-94cf-7ce6b6d409f7"},"value":{"type":"string","description":"The opaque Value to store. Use null to clear the stable Value slot. Non-null Values may contain at most 500,000 characters under Fieldguide's native validation semantics, which count Unicode surrogate pairs and base-character-plus-FE0E/FE0F presentation sequences as one character. Formatted-text HTML is canonicalized by Fieldguide. Image Values can be cleared but cannot be assigned through this endpoint.","nullable":true,"example":"Client acceptance response"}},"required":["field_uuid","value"],"additionalProperties":false},"FormValuesUpdate":{"type":"object","properties":{"tracked_changes_policy":{"description":"Controls unresolved tracked changes on targeted Values. Defaults to FAIL when omitted. FAIL rejects the entire batch. DISCARD rejects unresolved suggestions atomically before replacing the Values.","allOf":[{"$ref":"#/components/schemas/FormValueTrackedChangesPolicy"}]},"values":{"description":"The partial batch of Form Values to set or clear. Fields omitted from the batch remain unchanged, and each Field may appear only once. The combined length of all non-null Values must not exceed 1,000,000 Unicode code points.","minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/FormValueUpdateItem"}}},"required":["values"],"additionalProperties":false},"FormValueRead":{"type":"object","properties":{"value":{"type":"string","description":"The Value exactly as stored. Formatted text is returned as stored HTML. This is null for image-backed Values.","nullable":true,"example":"Client acceptance response"},"file_uuid":{"type":"string","description":"The stored File UUID for an image-backed Value; otherwise null.","format":"uuid","nullable":true,"example":"7d50d252-be0c-4d69-b77a-5bbdfef83f55"},"created_at":{"type":"string","description":"When the Value was first stored.","format":"date-time","example":"2026-02-01T12:30:00.000Z"},"updated_at":{"type":"string","description":"When the stored Value was last changed.","format":"date-time","example":"2026-03-10T12:30:00.000Z"},"has_pending_track_changes":{"type":"boolean","description":"Whether this formatted-text Value has unresolved track-change suggestions.","nullable":false,"example":false}},"required":["value","file_uuid","created_at","updated_at","has_pending_track_changes"]},"EngagementFormFieldRead":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"4d50d252-be0c-4d69-b77a-5bbdfef83f54"},"name":{"type":"string","example":"Approval status"},"type":{"description":"The value type accepted by this Field.","allOf":[{"$ref":"#/components/schemas/FormFieldType"}]},"sequence":{"type":"integer","nullable":true,"example":1,"description":"The Fieldguide display order. Null sequences appear first when sorting by sequence ascending and last when sorting descending."},"guidance":{"type":"string","nullable":true,"example":"Choose the status described in the policy.
","description":"Safe canonical HTML for Field guidance. The supported reduced CKEditor markup is paragraphs, line breaks, bold (`strong`), italic (`em`), underline (`u`), strikethrough (`s`), and links (`a` with `href`)."},"type_metadata":{"nullable":true,"description":"Validation metadata for this Field. List Fields expose their current allowed `options`; other Field types return null.","type":"object","allOf":[{"$ref":"#/components/schemas/FormFieldTypeMetadata"}]},"created_at":{"type":"string","format":"date-time","example":"2026-02-01T12:30:00.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2026-03-10T12:30:00.000Z"},"value":{"nullable":true,"description":"The current stored Value for this Field. Null when the Field is unanswered or cleared.","type":"object","allOf":[{"$ref":"#/components/schemas/FormValueRead"}]}},"required":["uuid","name","type","sequence","guidance","type_metadata","created_at","updated_at","value"]},"TimeTrackingFileRead":{"type":"object","properties":{"name":{"type":"string","example":"Board of Directors.docx"},"size":{"type":"number","example":137437},"mime_type":{"type":"string","example":"application/vnd.openxmlformats-officedocument.wordprocessingml.document"},"url":{"type":"string","format":"uri","example":"https://example.com/document.docx","nullable":true},"url_expiration":{"type":"string","format":"date-time","example":"2023-01-01T12:30:00.000Z","nullable":true},"report_data_processed_at":{"type":"string","format":"date-time","example":"2023-01-01T12:30:00.000Z","nullable":true},"record_count":{"type":"number","example":1000,"nullable":false}},"required":["name","size","mime_type","url","url_expiration","report_data_processed_at","record_count"]},"TimeTrackingFileCreate":{"type":"object","properties":{"report_start":{"type":"string","example":"2025-01-01T12:30:00.000Z"},"report_end":{"type":"string","example":"2025-01-01T12:30:00.000Z"}},"required":["report_start","report_end"]},"MilestoneAssociatedEngagementStatus":{"type":"string","enum":["Pending","In Progress","Complete","Archived"],"description":"An optional association to an Engagement lifecycle phase. It does not change the Engagement's current status or determine Milestone completion."},"MilestoneUpdate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"example":"Planning complete"},"due_date":{"type":"string","format":"date","example":"2026-03-15","nullable":true},"sequence":{"type":"integer","minimum":0,"maximum":32767,"example":1,"description":"The Milestone's stored display sequence."},"client_can_view":{"type":"boolean","description":"Whether client users can view the Milestone."},"owner_user_uuid":{"type":"string","format":"uuid","nullable":true,"description":"UUID of the firm user assigned to own the Milestone."},"associated_engagement_status":{"nullable":true,"description":"An optional association to an Engagement lifecycle phase. It does not change the Engagement's current status or determine Milestone completion.","allOf":[{"$ref":"#/components/schemas/MilestoneAssociatedEngagementStatus"}]}},"additionalProperties":false},"MilestoneReadLinks":{"type":"object","properties":{"self":{"description":"The canonical API URL for this Milestone","example":{"href":"https://api.fieldguide.io/v1/milestones/4d50d252-be0c-4d69-b77a-5bbdfef83f54","title":"Fetch this Milestone","type":"application/json"},"allOf":[{"$ref":"#/components/schemas/HalLink"}]},"collection":{"description":"The visible Milestones collection for the parent Engagement","example":{"href":"https://api.fieldguide.io/v1/engagements/821e8d9e-d2a8-480f-9187-5a685d3d0d71/milestones","title":"List Milestones for this Engagement","type":"application/json"},"allOf":[{"$ref":"#/components/schemas/HalLink"}]},"engagement":{"description":"The canonical API URL for the parent Engagement","example":{"href":"https://api.fieldguide.io/v1/engagements/821e8d9e-d2a8-480f-9187-5a685d3d0d71","title":"Fetch the parent Engagement","type":"application/json"},"allOf":[{"$ref":"#/components/schemas/HalLink"}]},"fieldguide":{"description":"A Fieldguide Engagement dashboard link containing this Milestone's UUID","example":{"href":"https://app.fieldguide.io/engagements/82027/dashboard?milestone=4d50d252-be0c-4d69-b77a-5bbdfef83f54","title":"Open the parent Engagement in Fieldguide","type":"text/html"},"allOf":[{"$ref":"#/components/schemas/HalLink"}]}},"required":["self","collection","engagement","fieldguide"]},"MilestoneRead":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"4d50d252-be0c-4d69-b77a-5bbdfef83f54"},"engagement_uuid":{"type":"string","format":"uuid","example":"821e8d9e-d2a8-480f-9187-5a685d3d0d71","description":"UUID of the Engagement that owns this Milestone."},"name":{"type":"string","example":"Planning complete"},"sequence":{"type":"integer","example":2,"description":"The Milestone's display order within its Engagement."},"associated_engagement_status":{"nullable":true,"description":"An optional association to an Engagement lifecycle phase. It does not represent the Engagement's current status or determine Milestone completion.","allOf":[{"$ref":"#/components/schemas/MilestoneAssociatedEngagementStatus"}]},"due_date":{"type":"string","format":"date","example":"2026-03-15","nullable":true},"completed_at":{"type":"string","format":"date-time","example":"2026-03-10T12:30:00.000Z","nullable":true,"description":"The authoritative completion indicator. Null means the Milestone is incomplete."},"completed_by_user_uuid":{"type":"string","format":"uuid","example":"6b242248-e2b9-4d41-8986-11b710860048","nullable":true,"description":"UUID of the user who completed the Milestone."},"owner_user_uuid":{"type":"string","format":"uuid","example":"ee196968-2a7a-48e9-97f9-d12f26a8ff94","nullable":true,"description":"UUID of the user assigned to own the Milestone."},"client_can_view":{"type":"boolean","example":true,"description":"Whether client users can view the Milestone."},"created_at":{"type":"string","format":"date-time","example":"2026-02-01T12:30:00.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2026-03-10T12:30:00.000Z"},"_links":{"$ref":"#/components/schemas/MilestoneReadLinks"}},"required":["uuid","engagement_uuid","name","sequence","associated_engagement_status","due_date","completed_at","completed_by_user_uuid","owner_user_uuid","client_can_view","created_at","updated_at","_links"]},"MilestoneCreate":{"type":"object","properties":{"name":{"type":"string","minLength":1,"example":"Planning complete","description":"The name of the Milestone."},"due_date":{"type":"string","format":"date","example":"2026-03-15","nullable":true},"sequence":{"type":"integer","minimum":0,"maximum":32767,"example":1,"description":"The Milestone's stored display sequence."},"client_can_view":{"type":"boolean","example":false,"description":"Whether client users can view the Milestone. Defaults to false when omitted."},"owner_user_uuid":{"type":"string","format":"uuid","nullable":true,"description":"UUID of the firm user assigned to own the Milestone."},"associated_engagement_status":{"nullable":true,"description":"An optional association to an Engagement lifecycle phase. It does not change the Engagement's current status or determine Milestone completion.","allOf":[{"$ref":"#/components/schemas/MilestoneAssociatedEngagementStatus"}]}},"required":["name","sequence"],"additionalProperties":false},"MilestoneSortBy":{"type":"string","enum":["created_at","sequence"]},"CommentReadLinks":{"type":"object","properties":{"self":{"description":"A URL the user can fetch the Comment","example":{"href":"https://api.fieldguide.io/v1/comments/5919b6e8-9ea9-4cf0-9598-3a44cad3c7f7","title":"Fetch this Comment","example":"application/json"},"allOf":[{"$ref":"#/components/schemas/HalLink"}]}},"required":["self"]},"CommentRead":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"4d50d252-be0c-4d69-b77a-5bbdfef83f54"},"content":{"type":"string","example":"The comment text in HTML format
Employees hired in 2023"},"author_user_uuid":{"type":"string","format":"uuid","example":"4d50d252-be0c-4d69-b77a-5bbdfef83f54"},"created_at":{"format":"date-time","type":"string","example":"2023-01-01T12:30:00.000Z"},"updated_at":{"format":"date-time","type":"string","example":"2023-01-01T12:30:00.000Z"},"_links":{"$ref":"#/components/schemas/CommentReadLinks"}},"required":["uuid","content","author_user_uuid","created_at","updated_at","_links"]},"CommentCreate":{"type":"object","properties":{"content":{"type":"string","example":"The comment text in HTML format
","minLength":1},"mentioned_user_uuids":{"type":"array","items":{"type":"string","format":"uuid","example":"edbf4962-20eb-499e-a7fa-eaff50c81630"},"description":"User UUIDs to mention and notify. Plain-text @Name text does not create mention notifications."}},"required":["content"]},"RequestCommentBulkCreateItem":{"type":"object","properties":{"request_uuid":{"type":"string","format":"uuid","example":"4d50d252-be0c-4d69-b77a-5bbdfef83f54"},"content":{"type":"string","example":"The comment text in HTML format
","minLength":1},"mentioned_user_uuids":{"type":"array","items":{"type":"string","format":"uuid","example":"edbf4962-20eb-499e-a7fa-eaff50c81630"},"description":"User UUIDs to mention and notify. Plain-text @Name text does not create mention notifications."}},"required":["request_uuid","content"]},"RequestCommentBulkCreate":{"type":"object","properties":{"comments":{"minItems":1,"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/RequestCommentBulkCreateItem"}}},"required":["comments"]},"CommentContextReadLinks":{"type":"object","properties":{"context_object":{"description":"A URL the user can fetch the Comment's Context","example":{"href":"https://api.fieldguide.io/v1/requests/9ddae459-8b25-41ef-a30d-d4c35d5915c9","title":"Fetch the Request this comment was left on","example":"application/json"},"allOf":[{"$ref":"#/components/schemas/HalLink"}]}},"required":["context_object"]},"CommentContextRead":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"4d50d252-be0c-4d69-b77a-5bbdfef83f54"},"type":{"type":"string","enum":["request"],"example":"request","description":"The kind of object this comment is attached to."},"_links":{"$ref":"#/components/schemas/CommentContextReadLinks"}},"required":["uuid","type","_links"]},"WebhookResource":{"type":"string","enum":["comments","companies","engagements","milestones","requests","users"],"description":"One or more resources to fire webhooks for. Available resources include comments, companies, engagements, milestones, requests, users. If `null`, webhooks will fire for all resources."},"WebhookRead":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"d952a7a8-3f88-46d0-b4de-ec690d97105c","description":"The unique ID for the webhook, referenced as `webhook_uuid` in webhook requests"},"description":{"type":"string","description":"A human-readable description of the webhook's use","example":"Firm internal systems"},"scopes":{"type":"array","nullable":true,"description":"One or more resources to fire webhooks for. Available resources include comments, companies, engagements, milestones, requests, users. If `null`, webhooks will fire for all resources.","example":["requests","users"],"items":{"$ref":"#/components/schemas/WebhookResource"}},"url":{"type":"string","format":"uri","example":"https://company-xyz.com/my-webhook-endpoint"},"created_at":{"format":"date-time","type":"string","example":"2023-01-01T12:30:00.000Z"}},"required":["uuid","description","scopes","url","created_at"]},"WebhookAction":{"type":"string","enum":["created","updated","deleted"]},"WebhookObjectType":{"type":"string","enum":["comments","companies","engagements","milestones","requests","users"]},"WebhookPayload":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"The unique ID for the event","example":"c7e4afd8-1b56-4621-83ad-86ec735fc23d"},"timestamp":{"format":"date-time","type":"string","description":"When the event occurred","example":"2023-01-01T12:30:00.000Z"},"action":{"allOf":[{"$ref":"#/components/schemas/WebhookAction"}]},"object_type":{"allOf":[{"$ref":"#/components/schemas/WebhookObjectType"}]},"object_uuid":{"type":"string","format":"uuid","description":"The UUID of the specific object for the event","example":"80d6783f-575d-4433-9dd8-25b81b2bad85"},"metadata":{"type":"array","description":"Array of metadata key-value pairs","example":[{"key":"company_uuid","value":"d952a7a8-3f88-46d0-b4de-ec690d97105c"},{"key":"engagement_uuid","value":"066a9ebd-07cf-458e-b506-dd66fab9cbcc"},{"key":"webhook_uuid","value":"5c8d4284-84f0-427c-be10-e350f7093a48"},{"key":"updated_property","value":"status"}],"items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}},"required":["uuid","timestamp","action","object_type","object_uuid","metadata"]},"WebhookReadWithSecret":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"d952a7a8-3f88-46d0-b4de-ec690d97105c","description":"The unique ID for the webhook, referenced as `webhook_uuid` in webhook requests"},"description":{"type":"string","description":"A human-readable description of the webhook's use","example":"Firm internal systems"},"scopes":{"type":"array","nullable":true,"description":"One or more resources to fire webhooks for. Available resources include comments, companies, engagements, milestones, requests, users. If `null`, webhooks will fire for all resources.","example":["requests","users"],"items":{"$ref":"#/components/schemas/WebhookResource"}},"url":{"type":"string","format":"uri","example":"https://company-xyz.com/my-webhook-endpoint"},"created_at":{"format":"date-time","type":"string","example":"2023-01-01T12:30:00.000Z"},"secret":{"type":"string","example":"trN7inAfsWlDy8VeqVB3","description":"A 20-character secret used for HMAC signing"}},"required":["uuid","description","scopes","url","created_at","secret"]},"WebhookCreate":{"type":"object","properties":{"description":{"type":"string","example":"Company XYZ Integration"},"scopes":{"type":"array","nullable":true,"description":"One or more resources to fire webhooks for. Available resources include comments, companies, engagements, milestones, requests, users. If `null`, webhooks will fire for all resources.","example":["requests","users"],"items":{"$ref":"#/components/schemas/WebhookResource"}},"url":{"type":"string","format":"uri","example":"https://company-xyz.com/my-webhook-endpoint"}},"required":["description","url"]},"WebhookUpdate":{"type":"object","properties":{"description":{"type":"string","example":"Company XYZ Integration"},"scopes":{"type":"array","nullable":true,"description":"One or more resources to fire webhooks for. Available resources include comments, companies, engagements, milestones, requests, users. If `null`, webhooks will fire for all resources.","example":["requests","users"],"items":{"$ref":"#/components/schemas/WebhookResource"}}}},"ApiResource":{"type":"string","description":"The API resource this scope grants access to. Expected values include: `comments`, `companies`, `controls`, `engagements`, `requests`, `users`, `webhooks`, `files`, `forms`, `sheets`, `sheet-columns`, `sheet-rows`, `insights`, `jobs`, `milestones`, `folders`. This list is not exhaustive; additional values can be added over time."}}},"security":[{"bearer":[]}],"externalDocs":{"description":"Fieldguide API Documentation","url":"https://fieldguide.com/developers"}}