latestOpenAPI 3.0.02026-08-216686147.9 KB

6f6009a58cdd

engagements

files

Fetch a File by Engagement and File UUIDs

get/v1/engagements/{engagement_uuid}/files/{file_uuid}

Path parameters

engagement_uuidstring uuid required

The UUID of the Engagement from which to get a File

file_uuidstring uuid required

The UUID of the File to fetch

Response

The Engagement File with the specified UUID

Example response

{
  "data": {
    "name": "Board of Directors.docx",
    "size": 137437,
    "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "url": "https://example.com/document.docx",
    "url_expiration": "2023-01-01T12:30:00.000Z",
    "uuid": "91aeda5e-4a3c-4090-90b1-cbf09d4c1ba1",
    "created_at": "2023-01-01T12:30:00.000Z",
    "updated_at": "2023-01-01T12:30:00.000Z",
    "_links": {
      "fieldguide": {
        "href": "https://example.com/resource/or/path",
        "title": "A description for the link",
        "type": "text/html"
      }
    }
  }
}