Location reminders

Get Location Reminders

Get all active location reminders.

Optionally filter by task_id to return only location reminders for a specific task.

This is a paginated endpoint. See the Pagination guide for details on using cursor-based pagination.

get/api/v1/location_reminders

Request

  • Base URL
    https://api.todoist.com
  • URL
    https://api.todoist.com/api/v1/location_reminders
  • Auth
    none declared

Query parameters

task_idstring nullable

String ID of the task

Example:6XGgmFVcrG5RRjVr
cursorstring nullable

An opaque string used as the cursor for pagination. Must be used with the same parameters from the previous request

Example:14540000435w8hj8pXXwPQJJch.X9DBH8ya2Xenok55
limitinteger

The number of objects to return in a page

Example:50

Response

Successful Response

next_cursorstring nullable required

Cursor for the next page of results, or null when there are no more results.

Example response

{
  "results": [
    {
      "id": "6XGgmFQrx44wfGHr",
      "item_id": "6XGgmFVcrG5RRjVr",
      "project_id": "6XGgm6PHrGgMpCFX",
      "notify_uid": "1029384756",
      "name": "Home",
      "loc_lat": "37.7749",
      "loc_long": "-122.4194",
      "loc_trigger": "on_enter",
      "radius": 100,
      "type": "location"
    }
  ],
  "next_cursor": "14540000435w8hj8pXXwPQJJch.X9DBH8ya2Xenok55"
}

Changes

No recorded changes to this operation across all 34 revisions of this API.