Sign in
engagements

List the version family of the specified Engagement Template

get/v1/engagement-templates/{uuid}/versions

Path parameters

uuidstring uuid required

The UUID of any Engagement Template in the version family — its working draft or any saved version

Query parameters

availabilityTemplateVersionAvailability[]

Filter to versions available in the given destinations. Repeat the query parameter to require several at once, which returns only versions available in all of them.

pagenumber nullable
per_pagenumber nullable
sort_order'asc' | 'desc'

Sort order for paginated results. Use desc to reverse the default ascending order.

Response

The Engagement Template's saved versions and its working draft

Example response

{
  "data": [
    {
      "uuid": "821e8d9e-d2a8-480f-9187-5a685d3d0d71",
      "version_tag": "Version 2",
      "version_description": "Adds the updated control wording for FY25.",
      "availability": [
        "new_engagements"
      ]
    }
  ],
  "_links": {
    "self": {
      "href": "https://api.fieldguide.io/v1/example?page=2&per_page=50"
    },
    "first": {
      "href": "https://api.fieldguide.io/v1/example?page=1&per_page=50"
    },
    "last": {
      "href": "https://api.fieldguide.io/v1/example?page=10&per_page=50"
    },
    "previous": {
      "href": "https://api.fieldguide.io/v1/example?page=1&per_page=50"
    },
    "next": {
      "href": "https://api.fieldguide.io/v1/example?page=3&per_page=50"
    }
  }
}

Changes

Changed in 1 of the 11 revisions of this API.1