Skip to content
Capturit Backend Docs

List of Events

GET api/event/list

This is used to retrieve the list of events.

Example Request

Terminal window
curl -X 'GET' \
  'http://localhost:8080/api/event/list?page=<page>&page_length=<page_length>' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN' \

Parameters

filter_by

Type: Query
Data Type: Integer
Required: Yes
Description: Specifies the criteria to filter the list
Values:

  • Created - 1
  • Attended - 2
  • Upncoming - 3
  • Highlight - 4
  • Archived - 5
  • Deleted - 6

include_archived

Type: Query
Data Type: Integer
Required: Yes
Description: Specifies whether to include archived events

include_trash

Type: Query
Data Type: Integer
Required: Yes
Description: Specifies whether to include trashed events

sort_by_start_date

Type: Query
Data Type: Integer
Required: Yes
Description: Specifies the sorting order for the list of events by start date
Values:

  • asc
  • desc (default)

user_id

Type: Query
Data Type: Integer
Required: Yes
Description: Retrieves the list of events based on the specified user_id

page

Type: Query
Data Type: Integer
Required: Yes
Description: The current page number in the pagination

page_length

Type: Query
Data Type: Integer
Required: Yes
Description: The number of items displayed per page in the pagination

Responses

200 - OK

The request was successful

Content Type: application/json
Content: Events

{
  "current_page": 0,
  "data": [
    {
      "id": 0,
      "event_name": "string",
      "event_cover_url": "string",
      "event_cover_preview_url": "string",
      "event_location": "string",
      "event_location_longitude": "string",
      "event_location_latitude": "string",
      "event_start": "2024-12-23T04:13:41.924Z",
      "event_end": "2024-12-23T04:13:41.924Z",
      "event_details": "string",
      "event_photos_per_guest": 0,
      "event_media_reveal": 0,
      "event_media_reveal_at": "2024-12-23T04:13:41.924Z",
      "event_status": 0,
      "event_visibility": 0,
      "event_likes_count": 0,
      "event_highlight": true,
      "event_archived": true,
      "event_deleted_on": "2024-12-23T04:13:41.924Z",
      "event_joined": 0,
      "event_liked": true,
      "event_group_chat_id": 0,
      "event_interested_count": 0,
      "event_going_count": 0,
      "event_settings": {
        "event_setting_join_approval": true
      },
      "event_organizer": {
        "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-23T04:13:41.924Z",
      "updated_at": "2024-12-23T04:13:41.924Z"
    }
  ],
  "first_page_url": "string",
  "from": 0,
  "next_page_url": "string",
  "path": "string",
  "per_page": "string",
  "prev_page_url": 0,
  "to": 0
}

400 - Bad Request

Validation Error

Content Type: application/json
Content:

{
  "param_name": [
    "string"
  ],
  "param_name_2": [
    "string"
  ],
  "error_message": "The user account is private"
}

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 240 requests per minute.

500 - Internal Server Error

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