Event

Defines the structure of the event resource.

Utilized by:

• GET event/{event_id}
• POST event/create

Schema

{
  "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-18T10:52:00.510Z",
  "event_end": "2024-12-18T10:52:00.510Z",
  "event_details": "string",
  "event_photos_per_guest": 0,
  "event_media_reveal": 0,
  "event_media_reveal_at": "2024-12-18T10:52:00.510Z",
  "event_status": 0,
  "event_visibility": 0,
  "event_likes_count": 0,
  "event_highlight": true,
  "event_archived": true,
  "event_deleted_on": "2024-12-18T10:52:00.510Z",
  "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_last_name": "string",
    "user_username": "string",
    "user_avatar_url": "string",
    "user_visible": "string"
  },
  "created_at": "2024-12-18T10:52:00.510Z",
  "updated_at": "2024-12-18T10:52:00.510Z"
}

Properties

id

Description: The event unique identifier
Data Type: Integer
Nullable: No
Table: Event

event_name

Description: The event’s name
Data Type: String
Nullable: No
Table: Event

event_cover_url

Description: The event’s cover image url
Data Type: String
Nullable: No
Table: Event

Note

The value of this is the API endpoint for fetching an event’s cover image. See: GET event/cover

Important

You must include a token query parameter in the URL to retrieve the image.

event_cover_preview_url

Description: The event’s cover image preview url
Data Type: String
Nullable: No
Table: Event

Note

The value of this is the API endpoint for fetching an event’s cover image. See: GET event/cover/preview

Important

You must include a token query parameter in the URL to retrieve the image.

event_location

Description: The event’s location
Data Type: String
Nullable: No
Table: Event

event_location_longitude

Description: The longitude of the event’s location
Data Type: String
Nullable: No
Table: Event

event_location_latitude

Description: The latitude of the event’s location
Data Type: String
Nullable: No
Table: Event

event_start

Description: The start time of the event
Data Type: String (date-time UTC)
Nullable: No
Table: Event

event_end

Description: The end time of the event
Data Type: String (date-time UTC)
Nullable: No
Table: Event

event_details

Description: The description of the event
Data Type: String
Nullable: No
Table: Event

event_photos_per_guest

Description: The number of photos that can be uploaded by the user to the event album
Data Type: Integer
Nullable: No
Table: Event

event_media_reveal

Description: The condition when will the gallery will be revealed to the guests
Data Type: Integer
Nullable: No
Table: Event

event_media_reveal_at

Description: The date and time on when the gallery will be revealed
Data Type: String (date-time UTC)
Nullable: Yes
Table: Event

event_status

Description: The status of the event
Data Type: Integer
Nullable: No
Values:

• Upcoming - 1
• Ongoing - 2
• Completed - 3

event_visibility

Description: The visibility of the event
Data Type: Integer
Nullable: No
Table: Event

event_likes_count

Description: The count of users who like the event
Data Type: Integer
Nullable: No
Table: Event

event_highlight

Description: Indicates whether the user has highlighted the event
Data Type: Boolean
Nullable: No

event_archived

Description: Indicates whether the user has archived the event
Data Type: Boolean
Nullable: No

event_deleted_on

Description: The date and time on when the event will be deleted
Data Type: String (date-time UTC)
Nullable: Yes
Table: Event

event_joined

Description: Indicates if the user joined the event
Data Type: Integer
Nullable: No
Values:

• Not joined - 0
• Joined - 1

event_liked

Description: Indicates if the user liked the event
Data Type: Boolean
Nullable: No

event_group_chat_id

Description: The group chat’s unique identifier
Data Type: Integer
Nullable: No
Table: Group Chat

event_interested_count

Description: The number of users who are interested in the event
Data Type: Integer
Nullable: No

event_going_count

Description: The number of users who are going to the event
Data Type: Integer
Nullable: No

event_settings

Description: The settings of the event
Data Type: Object
Nullable: No
Resource: Event Settings

event_organizer

Description: The event organizer
Data Type: Object
Nullable: No
Resource: Minimal User

created_at

Description: The timestamp when the record is created
Data Type: Timestamp
Nullable: No

updated_at

Description: The timestamp when the record is updated
Data Type: Timestamp
Nullable: Yes