markers

Save and restore your position in timelines.

Get saved timeline position

GET https://mastodon.example/api/v1/markers

Returns: Marker OAuth: User token + read:statuses Version history: 3.0.0 - added

Query Parameters

Name	Type	Description
timeline	array	Array of markers to fetch. String enum anyOf home, notifications. If not provided, an empty object will be returned.

Headers

Name	Type	Description
Authorization	string	Bearer <user token>

200 timeline[] = ["home", "notifications"]

{
  "notifications": {
    "last_read_id": "35098814",
    "version": 361,
    "updated_at": "2019-11-26T22:37:25.239Z"
  },
  "home": {
    "last_read_id": "103206604258487607",
    "version": 468,
    "updated_at": "2019-11-26T22:37:25.235Z"
  }
}

401 Invalid or missing Authorization header

{
  "error": "The access token is invalid"
}

Save position in timeline

POST https://mastodon.example/api/v1/markers

Returns: Marker OAuth: User token + write:statuses Version history: 3.0.0 - added

Headers

Name	Type	Description
Authorization	string	Bearer <user token>

Request Body

Name	Type	Description
home[last_read_id]	string	ID of the last status read in the home timeline.
notifications[last_read_id]	string	ID of the last notification read.

200 Calling this API with home[last_read_id] causes a marker to be created for the home timeline.

{
  "home": {
    "last_read_id": "103194548672408537",
    "version": 462,
    "updated_at": "2019-11-24T19:39:39.337Z"
  }
}

401 Invalid or missing Authorization header

{
  "error": "The access token is invalid"
}

409 If object is stale while being updated, an error will occur.

{
  "error": "Conflict during update, please try again"
}