Files

This page describes all the APIs relating to files

Get all Student's Files

get

Authorizations

bearerAuth

Path parameters

idintegerRequired

Serial database ID used to refer to a unique student record in OpenApply

Query parameters

since_datestring · date_timeOptional

Return results updated since the specified date, in UTC timezone

Example: 2025-01-01T00:00:00Z

deleted_sincestring · date_timeOptional

Return records that have been soft deleted since the given date

Example: 2025-01-01T00:00:00Z

date_uploadedstringOptional

categoriesstringOptional

Responses

200

successful

application/json

get

HTTPcURLJavaScriptPython

GET /api/v3/students/{id}/files HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

successful

{
  "files": [
    {
      "id": 46,
      "source": "Attachment",
      "name": "International_Student_Testing.png",
      "display_name": "International_Student_Testing.png",
      "date_uploaded": "2025-02-20T07:58:12.000Z",
      "size": 109115,
      "uploaded_by": {
        "id": 1,
        "type": "User"
      },
      "url": "http://faria.lvh.me/api/v3/secure_download/attachments/46",
      "categories": [
        {
          "id": 25,
          "name": "general"
        }
      ]
    },
    {
      "id": 9,
      "source": "DocumentSubmission",
      "name": "Tel_Invalid_OA.png",
      "display_name": "Tel_Invalid_OA.png",
      "date_uploaded": "2015-08-20T06:33:48.000Z",
      "size": 254430,
      "uploaded_by": {
        "id": 294,
        "type": "Parent"
      },
      "url": "http://faria.lvh.me/api/v3/secure_download/documents/9",
      "categories": [
        {
          "id": 25,
          "name": "general"
        }
      ]
    },
    {
      "id": 85,
      "source": "FieldFileValue",
      "name": "DP_-_Student_-_CAS.pdf",
      "display_name": "DP_-_Student_-_CAS.pdf",
      "date_uploaded": "2015-08-20T05:31:00.000Z",
      "size": 660160,
      "uploaded_by": {
        "id": null,
        "type": null
      },
      "url": "http://faria.lvh.me/api/v3/secure_download/files/85",
      "categories": [
        {
          "id": 25,
          "name": "general"
        }
      ]
    }
  ],
  "meta": {
    "page": 1,
    "pages": 1,
    "per_page": 500
  }
}