List Establishments

The List Establishments endpoint retrieves a list of all available establishments.

Endpoint

GET https://your-org-uuid.canteenweb.com/api/v1/admin/establishments

Example Request

curl -X GET "https://your-org-uuid.canteenweb.com/api/v1/admin/establishments" \
  -H "Authorization: Bearer your-access-token"

Response Structure

The API returns an array of establishment objects with their details.

Example Response:

{
  "success": true,
  "message": "Request was successful.",
  "data": [
    {
      "uuid": "9e11ee05-32a4-4898-8735-5a7f88003409",
      "name": "Sede 1",
      "allowed_order_pickup_time_type": "anytime",
      "allowed_order_pickup_time_interval": ["09:30", "10:30", "11:30"],
      "working_days": [1, 2, 3, 4, 5],
      "order_closing_time": "18:00:00",
      "menu_closing_time": null,
      "daily_order_closure": 1,
      "status": {
        "label": "Activado",
        "value": "enabled"
      },
      "created_at": "2025-01-27T17:20:49.000000Z",
      "updated_at": "2025-01-27T17:20:49.000000Z"
    },
    {
      "uuid": "9e11ee05-399b-4ab5-a714-2a0d50816527",
      "name": "Sede 2",
      "allowed_order_pickup_time_type": "anytime",
      "allowed_order_pickup_time_interval": [],
      "working_days": [1, 2, 3, 4, 5],
      "order_closing_time": "18:00:00",
      "menu_closing_time": null,
      "daily_order_closure": 0,
      "status": {
        "label": "Activado",
        "value": "enabled"
      },
      "created_at": "2025-01-27T17:20:49.000000Z",
      "updated_at": "2025-01-27T17:20:49.000000Z"
    }
  ]
}

Response Fields

Establishment Fields

Field	Type	Description
uuid	string	Unique identifier of the establishment.
name	string	Name of the establishment.
allowed_order_pickup_time_type	string	Defines order pickup time type (anytime or restricted time slots).
allowed_order_pickup_time_interval	array	List of allowed pickup times (if restricted).
working_days	array	Days of the week the establishment operates (1 = Monday, 7 = Sunday).
order_closing_time	string	The time at which orders close for the day (HH:MM:SS).
menu_closing_time	string/null	The time at which the menu closes (if applicable).
daily_order_closure	integer	Whether orders close automatically at the end of the day (1 = Yes, 0 = No).
status	object	The status of the establishment (contains label and value).
created_at	string	Timestamp when the establishment was created (YYYY-MM-DDTHH:MM:SS.ssssssZ / ISO 8601 format).
updated_at	string	Timestamp when the establishment was last updated (YYYY-MM-DDTHH:MM:SS.ssssssZ / ISO 8601 format).