latestOpenAPI 3.0.02026-08-216686147.9 KB

6f6009a58cdd

engagements

files

List Folders that belong to the specified Engagement

get/v1/engagements/{uuid}/folders

Path parameters

uuidstring uuid required

The UUID of the Engagement for which to get Folders

Query parameters

parent_folder_uuidstring uuid

An optional UUID of the parent folder

pagenumber nullable

per_pagenumber nullable

sort_order'asc' | 'desc'

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

Response

The list of Engagement Folders

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"
        }
      }
    }
  ],
  "_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"
    }
  }
}