Reminders
List reminders with filters and pagination
API Documentation
Status
Workspaces
Leads
- POSTCreate Lead
- GETGet a lead by id
- DELDelete a lead
- PATCHUpdate Lead
- POSTDelete many leads
- PATCHUpdate many leads
- POSTList leads with pagination and filters
- POSTAdd a list to leads
- POSTTrack a lead
- GETGet count of tracked leads
- POSTTrack leads
- POSTConnect a lead to a company
- POSTDisconnect a lead from a company
- POSTSearch leads
Lists
Campaigns
Reminders
Reminders
List reminders with filters and pagination
POST
/
reminders
/
list
curl --request POST \
--url https://api.breakcold.com/rest/reminders/list \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"cursor": 123,
"filter": {
"leads_filter": {
"leads": [
"<string>"
],
"not_leads": [
"<string>"
],
"is_company": true,
"is_tracked": true,
"email_status": "all",
"search": "<string>",
"sequences_steps": {
"id": [
"<string>"
],
"status": [
"is_opened"
]
},
"campaigns": [
"<string>"
],
"has_icebreaker": true,
"tags": [
"<string>"
],
"status": [
"<string>"
],
"has_list": true,
"has_no_list": true,
"lists": [
"<string>"
],
"has_owner": true,
"has_no_owner": true,
"owners": [
"<string>"
],
"score": [
"<string>"
],
"attributes": [
{
"id": "<string>",
"value": "<string>",
"operator": "equals"
}
]
},
"id_lead": "<string>",
"id_list": "<string>",
"is_done": true,
"id_status": "<string>",
"users": [
"<string>"
],
"search": "<string>"
},
"orderBy": {
"field": "created_at",
"type": "desc"
},
"pagination": {
"page": 1,
"page_size": 50.5
}
}'
{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"date": "2023-11-07T05:31:56Z",
"name": "<string>",
"cron": "<string>",
"cron_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_deleted": true,
"is_done": true,
"ressource_link": "<string>",
"id_lead": "<string>",
"id_space": "<string>"
}
],
"pagination": {
"page": 123,
"page_size": 123
}
}
Authorizations
Body
application/json
Available options:
all
, bounce
, not-sure-bounce
, valid
, no-email
Available options:
equals
, not_equals
, contains
, not_contains
, greater_than
, less_than
, greater_than_or_equal
, less_than_or_equal
, between
, in
, not_in
, is_empty
, is_not_empty
Response
200
application/json
Successful response
curl --request POST \
--url https://api.breakcold.com/rest/reminders/list \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"cursor": 123,
"filter": {
"leads_filter": {
"leads": [
"<string>"
],
"not_leads": [
"<string>"
],
"is_company": true,
"is_tracked": true,
"email_status": "all",
"search": "<string>",
"sequences_steps": {
"id": [
"<string>"
],
"status": [
"is_opened"
]
},
"campaigns": [
"<string>"
],
"has_icebreaker": true,
"tags": [
"<string>"
],
"status": [
"<string>"
],
"has_list": true,
"has_no_list": true,
"lists": [
"<string>"
],
"has_owner": true,
"has_no_owner": true,
"owners": [
"<string>"
],
"score": [
"<string>"
],
"attributes": [
{
"id": "<string>",
"value": "<string>",
"operator": "equals"
}
]
},
"id_lead": "<string>",
"id_list": "<string>",
"is_done": true,
"id_status": "<string>",
"users": [
"<string>"
],
"search": "<string>"
},
"orderBy": {
"field": "created_at",
"type": "desc"
},
"pagination": {
"page": 1,
"page_size": 50.5
}
}'
{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"date": "2023-11-07T05:31:56Z",
"name": "<string>",
"cron": "<string>",
"cron_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_deleted": true,
"is_done": true,
"ressource_link": "<string>",
"id_lead": "<string>",
"id_space": "<string>"
}
],
"pagination": {
"page": 123,
"page_size": 123
}
}