latestOpenAPI 3.0.02026-08-216686147.9 KB

6f6009a58cdd

engagements

files

List Files that belong to the specified Engagement

get/v1/engagements/{uuid}/files

Path parameters

uuidstring uuid required

The UUID of the Engagement for which to get Files

Query parameters

folder_uuidstring uuid

An optional UUID of the Folder to filter Files by

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 Files

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