Skip to content

List files

Returns a paginated list of all patient files of the company.

Request

GET /api/oauth/v2/resource/files

HeaderValue
AuthorizationBearer {access_token}

Query parameters

ParameterTypeRequiredDescription
offsetintegerNoStart position (default: 0)
limitintegerNoNumber of results (default: 50, max: 200)

Response

Success (200 OK)

json
{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "title": "MRI Report",
      "shortTitle": "MRI",
      "date": "2026-06-10",
      "filename": "mri-report.pdf",
      "notice": "Important report, please review.",
      "mimeType": "application/pdf",
      "fileSize": 204800,
      "download": "https://app.offisy.at/api/oauth/v2/resource/files/a1b2c3d4-e5f6-7890-abcd-ef1234567890/download",
      "customer": {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "firstName": "Anna",
        "lastName": "Muster"
      }
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "title": "Datei",
      "shortTitle": "Dat",
      "date": null,
      "filename": "upload.jpg",
      "notice": null,
      "mimeType": "image/jpeg",
      "fileSize": 51200,
      "download": "https://app.offisy.at/api/oauth/v2/resource/files/b2c3d4e5-f6a7-8901-bcde-f12345678901/download",
      "customer": {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "firstName": "Anna",
        "lastName": "Muster"
      }
    }
  ],
  "meta": {
    "total": 17,
    "offset": 0,
    "limit": 50
  }
}

Response fields

FieldTypeDescription
dataArrayList of files
data[].idstring (UUID)Unique ID of the file
data[].titlestringTitle of the file
data[].shortTitlestringShort title of the file
data[].datestring | nullDate of the file (YYYY-MM-DD)
data[].filenamestringOriginal filename
data[].noticestring | nullNotice/note for the file (stored encrypted server-side)
data[].mimeTypestringMIME type of the file (e.g. application/pdf)
data[].fileSizeintegerFile size in bytes
data[].downloadstringURL to download the decrypted file
data[].customerobjectAssigned customer
data[].customer.idstring (UUID)Customer ID
data[].customer.firstNamestringCustomer first name
data[].customer.lastNamestringCustomer last name
meta.totalintegerTotal number of files
meta.offsetintegerCurrent start position
meta.limitintegerNumber of returned entries
Beispiele
bash
curl -X GET "https://my.offisy.at/api/oauth/v2/resource/files?offset=0&limit=50" \
  -H "Authorization: Bearer {access_token}"
Parameter
Zuerst Token anfordern

Possible errors

StatusCodeDescription
401invalid_clientInvalid or missing access token
403insufficient_scopeScope medicals not present

Offisy GmbH