API V2 Route: Door Access

Last updated: October 5, 2026

General Details:

Endpoint	`/api/v2/door-access` and `/api/v2/door-access/<id>`
Headers	`Authorization: <JWT>`
HTTP Methods	`GET`
Request Body Format	`N/A`
Response Body Format	`JSON`
Required Scopes	`DOOR_ACCESS_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 (Residency)
`dateAssigned`	date or Date Filter	An ISO date string or a complex Date Filter can be utilized (Residency)
`dateStart`	date or Date Filter	An ISO date string or a complex Date Filter can be utilized (Residency)
`dateEnd`	date or Date Filter	An ISO date string or a complex Date Filter can be utilized (Residency)
`dateMovedIn`	date or Date Filter	An ISO date string or a complex Date Filter can be utilized (Residency)
`dateMovedOut`	date or Date Filter	An ISO date string or a complex Date Filter can be utilized (Residency)
`lastDateUpdate`	date or Date Filter	An ISO date string or a complex Date Filter can be utilized (Residency)
`cycle`	string	Internal numerical ID of Cycle (Residency)
`ruleName`	string	Name of Door Access Rule (Door Access Rule)

Supported Residency Statuses:

`ASSIGNED`	The residency has been assigned through selection or an admin
`CANCELLED`	The residency has been cancelled by an admin
`TRANSFERRED`	This residency's student has transferred to another location
`INCOMING`	Residency start date has passed, but no move-in has been recorded
`CURRENT`	Student has a move-in date, and is currently residing in this space
`MOVED_OUT`	Student has been marked as having moved out
`OVERSTAY`	Student has not moved-out, but the end date of the Residency has passed

API Response:

Field Name	Data Type	Notes
profile	ProfileThin	Student for which the residency is tied to
cycle	CycleThin	Cycle in which the residency is for
inventory	object	Object representing the full inventory path of the residency, consisting of BuildingThin, SuiteThin, RoomThin, BedThin
dateStart	date string	ISO date string. Start date of associated residency
dateEnd	date string	ISO date string. End date of associated residency
dateMovedIn	date string	ISO date string.
dateMovedOut	date string	ISO date string.
accessRules	DoorAccessRuleThin[]	List of all Door Access Rules that apply to this record
accessStart	date string	ISO date string. Start of door access period; calculated based on applied access rules.
accessEnd	date string	ISO date string. End of door access period; calculated based on applied access rules.

Example Response:

{
    "entities": [
        {
            "profile": {
                "id": "4697",
                "name": "Braden Grute",
                "sisId": "B0011879"
            },
            "cycle": {
                "id": "9",
                "name": "Fall Semester Returning",
                "externalTermCode": "FA2026"
            },
            "inventory": {
                "building": {
                    "id": "7",
                    "name": "Red Tower",
                    "externalCode":"RT01" },
                "suite": {
                    "id": "56",
                    "name": "Suite 2",
                    "externalCode":"" },
                "room": {
                    "id": "395",
                    "name": "201",
                    "externalCode":"201" },
                "bed": {
                    "id": "7435",
                    "name": "B",
                    "externalCode":"" }
            },
            "dateStart": "2025-09-30T08:00:00.000Z",
            "dateEnd": "2025-12-10T23:59:59.999Z",
            "dateMovedIn": "2025-09-28T08:45:00.559Z",
            "dateMovedOut": "2025-12-08T23:59:59.999Z",
            "accessRules": [
            {
                "name":"Sport Early Arrival",
                "minPadAmountPre":"720",
                "minPadAmountPost":"0"
            },
            {
                "name":"Senior Late Stay",
                "minPadAmountPre":"0",
                "minPadAmountPost":"1440"
            }],
            "accessStart": "2025-09-29T20:00:00.000Z",
            "accessEnd": "2025-12-11T23:59:59.999Z"
        }
    ],
    "metaData": {
        "agentId": "ab5f95b2-303a-403b-85fd-ab1d0cd8093c",
        "rateLimits": {
            "tenant": {
                "limit": 50,
                "remaining": 47,
                "reset": 1759520782000
            },
            "agent": {
                "limit": 10,
                "remaining": 9,
                "reset": 1759520783000
            }
        },
        "pagination": {
            "offset": 0,
            "limit": 1000
        }
    }
}