FIfieldguide
forms

Get the specified Engagement Form

get/v1/forms/{uuid}

Request

  • Base URL
    https://api.fieldguide.io
  • URL
    https://api.fieldguide.io/v1/forms/{uuid}
  • Auth
    HTTP bearer

Path parameters

uuidstring uuid required

The UUID of the attached Form to retrieve

Response

The visible active Form attached to an Engagement or Engagement Template

Example response

{
  "data": {
    "uuid": "4d50d252-be0c-4d69-b77a-5bbdfef83f54",
    "name": "Client acceptance form",
    "description": "Standard client acceptance questions",
    "created_at": "2026-02-01T12:30:00.000Z",
    "updated_at": "2026-03-10T12:30:00.000Z",
    "_links": {
      "fieldguide": {
        "href": "https://example.com/resource/or/path",
        "title": "A description for the link",
        "type": "text/html"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 15 revisions of this API.