latestOpenAPI 3.0.02026-08-216686147.9 KB
6f6009a58cdd
engagements
Fetch the specified Engagement
get/v1/engagements/{uuid}
Path parameters
uuidstring uuid required
The UUID of the Engagement to retrieve
Response
The Engagement details
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"
}
}
}
}