Reminders

Get a reminder

Retrieve a single reminder by its unique ID. Returns the canonical /v2 envelope `{ data: { reminder } }` — see Migration notes below.

GET /v2/reminders/{reminderId}

Parameters

Path parameters

reminderId

string (uuid) required

Query parameters

include

object

select

object

Responses

200 — Successful response

Content-Type: application/json

data

object required

data.reminder

object required

data.reminder.id

string (uuid) required

data.reminder.user_id

string

data.reminder.text

string | null

data.reminder.due_at_date

string (date-time)

data.reminder.due_at_time

string (date-time)

data.reminder.is_complete

boolean

data.reminder.email_sent

boolean

data.reminder.push_notification_sent

boolean

data.reminder.recurrence

string | null

data.reminder.last_completed_at

string (date-time)

data.reminder.next_occurrence_at

string (date-time)

data.reminder.created_at

string (date-time)

data.reminder.is_overdue

boolean

data.reminder.next_cursor

string

data.reminder.reminders_contacts

array<object>

data.reminder.users

object | null

Example

{
  "data": {
    "reminder": {
      "id": "00000000-0000-0000-0000-000000000000"
    }
  }
}

400 — Request body failed validation.

Content-Type: application/json

(body)

any

401 — Missing or invalid API key.

Content-Type: application/json

(body)

any

403 — Valid key, insufficient permission.

Content-Type: application/json

(body)

any

404 — Resource does not exist.

Content-Type: application/json

(body)

any

409 — Request conflicts with the current state of the resource.

Content-Type: application/json

(body)

any

429 — Rate limit exceeded.

Content-Type: application/json

(body)

any

500 — Unexpected server error.

Content-Type: application/json

(body)

any

Code samples

curl https://api.prod.getdex.com/v2/reminders/00000000-0000-0000-0000-000000000000 \
  --header 'Authorization: Bearer YOUR_API_KEY'

fetch('https://api.prod.getdex.com/v2/reminders/00000000-0000-0000-0000-000000000000', {
  headers: {
    Authorization: 'Bearer YOUR_API_KEY'
  }
})

requests.get(
    "https://api.prod.getdex.com/v2/reminders/00000000-0000-0000-0000-000000000000",
    headers={
      "Authorization": "Bearer YOUR_API_KEY"
    }
)

Filtering contacts

The where filter DSL for the contacts endpoints — every key, its value shapes, and how conditions combine.

Update a reminder

Partially update a reminder by its ID. **Requires an `Idempotency-Key` header**. Returns `{ data: { reminder: {...} } }` with the post-update row.