Skip to content
Capturit Backend Docs

Event QR Code

GET api/event/qr-code/{event_id}

This is used to retrieve or generate the event’s QR code.

Example Request

Terminal window
curl -X 'GET' \
  'http://localhost:8080/api/event/qr-code/<event_id>' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN' \

Parameters

event_id

Type: Path
Data Type: Integer
Required: Yes
Description: The unique identifier for the event

Responses

200 - OK

The request was successful

Content Type: application/json
Content: Event Shareable Link

{
  "id": 0,
  "event_shareable_id": "string",
  "event_shareable_valid": true,
  "event_shareable_url": "string",
  "event_shareable_image_url": "string",
  "user": {
    "id": 0,
    "user_first_name": "string",
    "user_middle_name": "string",
    "user_last_name": "string",
    "user_username": "string",
    "user_avatar_url": "string",
    "user_visible": "string"
  },
  "created_at": "2024-12-23T06:51:18.676Z",
  "updated_at": "2024-12-23T06:51:18.676Z"
}

400 - Bad Request

Validation Error

Content Type: application/json
Content:

{
  "param_name": [
    "string"
  ],
  "param_name_2": [
    "string"
  ],
  "error_message": "The user does not have permission to access the URL for this event."
}

404 - Not Found

The server could not find the requested resource.

Content Type: text/plain
Content:

Event not found!

401 - Unauthorized

The request requires valid bearer token, but none were provided, or the bearer token is invalid.

429 - Too Many Requests

The user has exceeded the rate limit of 180 requests per minute.

500 - Internal Server Error

There is an issue with the backend. Sentry will provide a more detailed report on the problem.