Skip to main content
GET
/
api
/
lockers
/
{lockerNo}
Get Single Locker
curl --request GET \
  --url https://api.example.com/api/lockers/{lockerNo}
{
  "lockerNo": "<string>",
  "employeeNumber": "<string>",
  "size": 123,
  "location": "<string>",
  "isEmpty": true
}

​
HTTP Method and Path

GET /api/lockers/{lockerNo}

​
Path Parameters

​
lockerNo
string
required
The unique locker number to retrieve

​
Response

Returns a single locker object.
​
lockerNo
string
required
The unique locker number identifier
​
employeeNumber
string
The employee number assigned to this locker (null or empty if unassigned)
​
size
integer
required
The size of the locker
​
location
string
required
The physical location of the locker
​
isEmpty
boolean
required
Indicates whether the locker is currently empty

​
Example Request

cURL
curl -X GET https://api.example.com/api/lockers/A001 \
  -H "Content-Type: application/json"

​
Example Response

​
Success (200 OK)

{
  "lockerNo": "A001",
  "employeeNumber": "EMP12345",
  "size": 2,
  "location": "Building A - Floor 1",
  "isEmpty": false
}

​
Error (404 Not Found)

"Locker not found"

Build docs developers (and LLMs) love

Get started for freeTalk to us