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

​
HTTP Method and Path

GET /api/lockers

​
Response

Returns an array of locker objects ordered by locker number.
​
data
array
Array of locker objects

​
Example Request

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

​
Example Response

[
  {
    "lockerNo": "A001",
    "employeeNumber": "EMP12345",
    "size": 2,
    "location": "Building A - Floor 1",
    "isEmpty": false
  },
  {
    "lockerNo": "A002",
    "employeeNumber": "",
    "size": 1,
    "location": "Building A - Floor 1",
    "isEmpty": true
  },
  {
    "lockerNo": "B001",
    "employeeNumber": "EMP67890",
    "size": 3,
    "location": "Building B - Floor 2",
    "isEmpty": false
  }
]

Build docs developers (and LLMs) love

Get started for freeTalk to us