Skip to main content
GET
/
events
/
{eventId}
/
reminders
Gets reminders for an event
curl --request GET \
  --url https://api.smokeball.com/events/{eventId}/reminders \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
[
  {
    "offset": 10,
    "offsetTypeId": 1,
    "isAllDayReminder": false,
    "userIds": [
      "<string>"
    ]
  }
]

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
eventId
string
required

Response

When request is successful. Returns the collection of reminders.

​
offset
integer<int32>

Offset of the reminder.

Value must be between 0 and 100.

Example:

10

​
offsetTypeId
integer<int32>

Offset Type id of the reminder.

Possible values: 1 = Minute

2 = Hourly
        
3 = Daily
        
4 = Weekly
        
5 = Monthly
Example:

1

​
isAllDayReminder
boolean

Boolean flag indicating if the reminder is an all day reminder.

Example:

false

​
userIds
string[] | null

Array of unique identifier of the users of the reminder.