title | description | menu | aliases | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
markers API methods | Save and restore your position in timelines. |
|
|
GET /api/v1/markers HTTP/1.1
Get current positions in timelines.
Returns: Hash of timeline key and associated [Marker]({{< relref "entities/Marker" >}})
OAuth: User token + read:statuses
Version history:
3.0.0 - added
Authorization : {{}} Provide this header with Bearer <user_token>
to gain authorized access to this API method.
timeline[] : Array of String. Specify the timeline(s) for which markers should be fetched. Possible values: home
, notifications
. If not provided, an empty object will be returned.
A request with ?timeline[]=home&timeline[]=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" } }
Invalid or missing Authorization header.
{ "error": "The access token is invalid" }
POST /api/v1/markers HTTP/1.1
Save current position in timeline.
Returns: [Marker]({{< relref "entities/marker" >}})
OAuth: User token + write:statuses
Version history:
3.0.0 - added
Authorization : {{}} Provide this header with Bearer <user_token>
to gain authorized access to this API method.
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.
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" } }
Invalid or missing Authorization header.
{ "error": "The access token is invalid" }
If object is stale while being updated, an error will occur.
{ "error": "Conflict during update, please try again" }
{{< page-relref ref="methods/timelines#home" caption="GET /api/v1/timelines/home (with min_id
or since_id
parameter)" >}}
{{< page-relref ref="methods/notifications#get" caption="GET /api/v1/notifications (with min_id
or since_id
parameter)" >}}
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/markers_controller.rb" caption="app/controllers/api/v1/markers_controller.rb" >}}