Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/astrxnomo/tourify/llms.txt

Use this file to discover all available pages before exploring further.

Events represent scheduled tourist activities in Tourify — concerts, guided tours, festivals, and more. List and detail endpoints are public; registering for an event requires authentication.

​
GET /api/events

Returns a paginated list of all events, sorted by date ascending. Results can be filtered by city or restricted to upcoming events only. No authentication is required. Authentication: None

​
Query Parameters

​
city_id
integer
Filter events to only those belonging to the specified city. Must be a valid city ID.
​
upcoming
boolean
When true, returns only events whose date is in the future (i.e., date > now).

​
Response Fields

Returns a JSON array of event objects.
​
id
integer
Unique identifier of the event.
​
city_id
integer
ID of the city the event belongs to.
​
place_id
integer | null
ID of the associated place, or null if not tied to a specific place.
​
title
string
Display title of the event.
​
description
string
Full description of the event.
​
date
string (ISO 8601)
Date and time of the event.
​
images
array
Array of image objects associated with the event.
​
city
object
The city the event is held in.
​
place
object | null
The place where the event is hosted, or null if not linked to a specific place.
​
created_at
string (ISO 8601)
Timestamp when the event record was created.
​
updated_at
string (ISO 8601)
Timestamp when the event record was last updated.
Example request
curl http://localhost:8000/api/events \
  -H "Accept: application/json" \
  -G \
  --data-urlencode "city_id=3" \
  --data-urlencode "upcoming=true"

​
GET /api/events/

Returns the full detail for a single event, including its images, city, place, reviews (each with the reviewing user), total registration count, and whether the currently authenticated user is registered. Authentication: None required. Optionally include a Bearer token — when provided, is_registered reflects the current user’s registration status. When absent, is_registered is always false.

​
Path Parameters

​
event
integer
required
The ID of the event to retrieve.

​
Response Fields

​
id
integer
Unique identifier of the event.
​
city_id
integer
ID of the city the event belongs to.
​
place_id
integer | null
ID of the associated place, or null.
​
title
string
Display title of the event.
​
description
string
Full description of the event.
​
date
string (ISO 8601)
Date and time of the event.
​
registrations_count
integer
Total number of users currently registered for this event.
​
is_registered
boolean
true if the authenticated user is registered for this event; false if they are not registered or no token was provided.
​
images
array
Array of image objects. See GET /api/events for the image object shape.
​
city
object
The city the event is held in. See GET /api/events for shape.
​
place
object | null
The place where the event is hosted, or null.
​
reviews
array
Array of review objects left on this event.
​
created_at
string (ISO 8601)
Timestamp when the event record was created.
​
updated_at
string (ISO 8601)
Timestamp when the event record was last updated.
Example request
# Unauthenticated — is_registered will always be false
curl http://localhost:8000/api/events/12 \
  -H "Accept: application/json"

# Authenticated — is_registered reflects the token owner's status
curl http://localhost:8000/api/events/12 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {your-token}"

​
POST /api/events//register

Registers the authenticated user for the specified event. The operation is idempotent — if the user is already registered, the existing registration is returned without creating a duplicate. Returns HTTP 201 on both a new registration and an existing one.
This endpoint requires authentication. Include your bearer token in the Authorization header.
Authentication: Required (auth:sanctum).

​
Path Parameters

​
event
integer
required
The ID of the event to register for.

​
Response Fields

​
id
integer
Unique identifier of the registration record.
​
user_id
integer
ID of the registered user.
​
event_id
integer
ID of the event that was registered for.
​
event
object
The full event object for the registration. Includes id, title, description, date, city_id, place_id, created_at, and updated_at.
​
created_at
string (ISO 8601)
Timestamp when the registration was created.
​
updated_at
string (ISO 8601)
Timestamp when the registration was last updated.
Example request
curl -X POST http://localhost:8000/api/events/12/register \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {your-token}"

​
DELETE /api/events//register

Cancels the authenticated user’s registration for the specified event. If no registration exists, the request still returns a success response.
This endpoint requires authentication. Include your bearer token in the Authorization header.
Authentication: Required (auth:sanctum).

​
Path Parameters

​
event
integer
required
The ID of the event whose registration should be cancelled.

​
Response Fields

​
message
string
A confirmation message. Value: "Registro cancelado."
Example request
curl -X DELETE http://localhost:8000/api/events/12/register \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {your-token}"

Build docs developers (and LLMs) love

Get started for freeTalk to us