GET
/
reminders
curl --request GET \
  --url https://api.breakcold.com/reminders \
  --header 'X-API-KEY: <api-key>'
[
  {
    "id_reminder": "reminder001",
    "name": "Reminder 1",
    "id_lead": "lead001",
    "date": "2021-06-01T12:00:00Z",
    "is_done": false
  }
]

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
id_space
string

The workspace identifier. This is not required when 'X-API-KEY' is provided.

​
id_lead
string

The lead identifier to filter reminders by lead.

​
id_list
string

Filter reminders by list ID.

​
is_done
enum<string>

Filter reminders by their done status.

Available options:
true,
false
​
id_status
string

Filter reminders by status ID.

​
ids_user
string

Filter reminders by user IDs.

​
cursor
string

Cursor for pagination.

​
take
integer

Number of reminders to take.

Required range: 1 <= x <= 100

Response

200
application/json
A list of reminders.

The response is of type any.

Delete a specific reminderCreate a reminder