Skip to content
calternal docs

List a Note’s block reminders

GET
/api/v1/notes/{id}/reminders
curl --request GET \
  --url https://example.com/api/v1/notes/example/reminders \
  --header 'Authorization: Bearer <token>'

Requires a signed-in User with the data scope and access to the Note. It returns 404 when the Note is missing or 409 when its reminder data is invalid. Route: /api/v1/notes/{id}/reminders. Inputs: id. Safe reads can use bounded retries.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
reminders
required
Array<object>
object
audience
required

everyone or only_me.

string
block_id
required

Stable block identity within the Note.

string
id
required

Stable UUID key in calternal-reminders.

string
instant
required

Absolute trigger time, normalized to UTC.

string
revision
required

Monotonic reminder revision used to fence a stale Undo.

integer format: int64
setter
required

User who set this reminder.

string
Examplegenerated
{
  "reminders": [
    {
      "audience": "example",
      "block_id": "example",
      "id": "example",
      "instant": "example",
      "revision": 1,
      "setter": "example"
    }
  ]
}

401

Section titled “401”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

404

Section titled “404”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

409

Section titled “409”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}