API V2 Route: Applications

General Details:

Endpoint	/api/v2/applications and /api/v2/applications/<id>
Headers	Authorization: <JWT>
HTTP Methods	GET
Request Body Format	N/A
Response Body Format	JSON
Required Scopes	APPLICATIONS_GET

 

Supported Request Filters:

These filters should be query parts in the URL string and follow the standard pattern of <baseUrl>?<key>=<filter>&...

Field Name	Filter Type	Notes
status	string	See table for acceptable values
dateCreated	date or Date Filter	An ISO date string or a complex Date Filter can be utilized
dateSubmitted	date or Date Filter	An ISO date string or a complex Date Filter can be utilized

 

Supported Application Statuses:

STARTED	Application has been started, but not completed
SUBMITTED	Complete application has been submitted
CANCELLED	Application has been cancelled by an admin
APPROVED	Application has been approved by an admin
REJECTED	Application has been rejected by an admin
RESIDENT	Student has been assigned a residency for this application

 

API Response:

Field Name	Data Type	Notes
id	string	Globally unique identifier
dateCreated	date string	ISO date string
dateSubmitted	date string	ISO date string
status	enum string	Current status of the application
student	ProfileThin	Student for which the application is tied to
cycle	CycleThin	Cycle for which the application is for
tags	string[]	Array of tag caption strings
percentComplete	number

 

Example Response:

{
    "entities": [
        {
            "id": "42",
            "dateCreated": "2025-09-25T13:31:55.357Z",
            "dateSubmitted": "2025-09-27T18:00:00.000Z",
            "student": {
                "id": "176",
                "name": "Francis Schneider",
                "sisId": "A0015436"
            },
            "cycle": {
                "id": "4",
                "name": "Fall Semester Incoming",
                "externalTermCode": "FA2026"
            },
            "tags": ["Night Owl","Prefers high floor","ESA Okay"],
            "percentComplete": 100,
        }
    ],
    "metaData": {
        "agentId": "ab5f95b2-303a-403b-85fd-ab1d0cd8093c",
        "rateLimits": {
            "tenant": {
                "limit": 50,
                "remaining": 49,
                "reset": 1759520782000
            },
            "agent": {
                "limit": 10,
                "remaining": 9,
                "reset": 1759520783000
            }
        },
        "pagination": {
            "offset": 0,
            "limit": 1000
        }
    }
}