Areas

User Guide

For a user-facing walkthrough, see Locations & Areas.

Named zones within a location for organizing bins.

---

GET /api/locations/{locationId}/areas

Lists all areas in a location, including an unassigned_count of bins with no area.

Path parameters: locationId (UUID)

Response (200)

{
  "results": [
    {
      "id": "uuid",
      "location_id": "uuid",
      "name": "Garage",
      "parent_id": null,
      "bin_count": 12,
      "descendant_bin_count": 18,
      "created_by": "uuid",
      "created_at": "...",
      "updated_at": "..."
    }
  ],
  "count": 4,
  "unassigned_count": 7
}

---

POST /api/locations/{locationId}/areas

Creates a new area within a location.

Path parameters: locationId (UUID)

Request body

Field	Type	Required	Description
name	string	Yes	Max 255 characters
parent_id	string | null	No	UUID of an existing area in the same location to nest under. Omit or pass null for a top-level area.

Response (201): The created Area object.

---

PUT /api/locations/{locationId}/areas/{areaId}

Renames an existing area.

Path parameters: locationId (UUID), areaId (UUID)

Request body

Field	Type	Required	Description
name	string	Yes	Max 255 characters

Response (200): The updated Area object.

---

DELETE /api/locations/{locationId}/areas/{areaId}

Deletes an area. Bins in the area become unassigned (area_id = NULL); they are not deleted.

Path parameters: locationId (UUID), areaId (UUID)

Response (200)

{
  "message": "Area deleted",
  "descendant_area_count": 2,
  "descendant_bin_count": 5
}

descendant_area_count and descendant_bin_count indicate how many child areas and bins were affected by the deletion.