Skip to content

List Establishments ​

Returns the establishments of the organization, that is the physical cafeterias or points of sale. Most organizations have one or two; large ones have one per campus.

GET https://api.canteenweb.com/api/v1/admin/establishments

There are no filters. The list is paginated like every other list, see Pagination.

Example ​

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

Response ​

json
{
  "data": [
    {
      "uuid": "9e11ee05-32a4-4898-8735-5a7f88003409",
      "name": "Sede 1",
      "allowed_order_pickup_time_type": "interval",
      "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"
    }
  ],
  "links": {
    "first": "https://api.canteenweb.com/api/v1/admin/establishments?page=1",
    "last": "https://api.canteenweb.com/api/v1/admin/establishments?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.canteenweb.com/api/v1/admin/establishments",
    "per_page": 25,
    "to": 2,
    "total": 2
  },
  "success": true,
  "message": "Request was successful."
}

Fields ​

FieldTypeDescription
uuidstringIdentifier of the establishment. Use it in the establishment filter of List Orders.
namestringEstablishment name.
allowed_order_pickup_time_typestringHow pickup times work: anytime (no time chosen), fixed (one time for everyone) or interval (the parent picks one of the listed slots).
allowed_order_pickup_time_intervalarray of HH:MMPickup slots offered when the type is interval. Empty otherwise.
working_daysarray of integersDays that accept orders, ISO numbering: 1 is Monday, 7 is Sunday.
order_closing_timeHH:MM:SS or nullTime after which orders for the same day are no longer accepted.
menu_closing_timeHH:MM:SS or nullSame cut off, applied to menu products only. null means the general closing time applies.
daily_order_closureintegerNumber of days before pickup that ordering closes. 0 means same day orders are allowed until the closing time, 1 means orders must be placed the day before.
statusenumenabled or disabled. Disabled establishments do not take orders but keep their history.
created_at, updated_attimestampISO 8601.

Private API. Access is granted per organization.