latestOpenAPI 3.0.02026-08-216686147.9 KB

6f6009a58cdd

engagements

files

Fetch a Folder by Engagement and Folder UUIDs

get/v1/engagements/{engagement_uuid}/folders/{folder_uuid}

Path parameters

engagement_uuidstring uuid required

The UUID of the Engagement from which to get a Folder

folder_uuidstring uuid required

The UUID of the folder to fetch

Response

The Engagement Folder with the specified UUID

Example response

{
  "data": {
    "uuid": "821e8d9e-d2a8-480f-9187-5a685d3d0d71",
    "parent_folder_uuid": "721e8d9e-d2a8-480f-9187-5a685d3d0d71",
    "engagement_uuid": "921e8d9e-d2a8-480f-9187-5a685d3d0d71",
    "name": "Documents",
    "path": "/grandparent/parent",
    "created_at": "2024-03-19T12:00:00Z",
    "_links": {
      "fieldguide": {
        "href": "https://example.com/resource/or/path",
        "title": "A description for the link",
        "type": "text/html"
      }
    }
  }
}