Sign in
latestOpenAPI 3.0.02026-08-216686147.9 KB

6f6009a58cdd

engagements

List available Engagements

get/v1/engagements

Query parameters

templates'include' | 'exclude' | 'only'

Filter to include, exclude, or only show template engagements

uuidsstring[]

Filter Engagements by UUID. Repeat the query parameter for multiple UUIDs.

engagement_lead_user_uuidstring uuid

Filter Engagements by the UUID of their Engagement Lead User.

client_owner_user_uuidstring uuid

Filter Engagements by the UUID of their Client Owner User.

statusesEngagementsQueryStatusLabel[]

Filter Engagements by status. Repeat the query parameter for multiple statuses.

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

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

Response

The Engagements accessible by the user

Example response

{
  "data": [
    {
      "uuid": "821e8d9e-d2a8-480f-9187-5a685d3d0d71",
      "name": "SOC 2 - Type 1",
      "company_uuid": "022723f4-1d6a-4c6c-9387-f63c7d66f0fc",
      "start_date": "2023-05-23",
      "end_date": "2023-07-30",
      "created_at": "2023-01-01T12:30:00.000Z",
      "report_issue_date": "2023-07-30",
      "engagement_lead_user_uuid": "022723f4-1d6a-4c6c-9387-f63c7d66f0fc",
      "client_owner_user_uuid": "022723f4-1d6a-4c6c-9387-f63c7d66f0fc",
      "identifier": "E0001-A",
      "_links": {
        "fieldguide": {
          "href": "https://example.com/resource/or/path",
          "title": "A description for the link",
          "type": "text/html"
        }
      }
    }
  ],
  "_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"
    }
  }
}