POST
/
reminders
/
list
List reminders with filters and pagination
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_contract": true,
      "is_tracked": true,
      "ai_enabled": true,
      "email_status": "all",
      "search": "<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>",
    "late_tasks": true,
    "ai_generated": true,
    "ai_action_channel": "<string>",
    "ai_action_priority": "<string>",
    "date_from": "2023-11-07T05:31:56Z",
    "date_to": "2023-11-07T05:31:56Z",
    "no_date": true
  },
  "timezone": "<string>",
  "orderBy": {
    "field": "created_at",
    "type": "desc"
  },
  "pagination": {
    "page": 1,
    "page_size": 50.5
  }
}'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "date": "<string>",
      "name": "<string>",
      "cron": "<string>",
      "cron_id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "is_deleted": true,
      "is_done": true,
      "ressource_link": "<string>",
      "ai_generated": true,
      "ai_action_channel": "<string>",
      "ai_action_description": "<string>",
      "ai_action_priority": "<string>",
      "ai_action_reasoning": "<string>",
      "ai_time_precision": "<string>",
      "ai_followup_strategy": "<string>",
      "ai_action_rationale": "<string>",
      "ai_draft_subject": "<string>",
      "ai_draft_message": "<string>",
      "ai_draft_metadata": "<string>",
      "id_lead": "<string>",
      "id_space": "<string>"
    }
  ],
  "pagination": {
    "page": 123,
    "page_size": 123
  }
}

Authorizations

X-API-KEY
string
header
required

Body

application/json
cursor
number | null
filter
object
timezone
string
orderBy
object
pagination
object

Response

Successful response

data
object[]
required
pagination
object
required