Get mutations
Get list of mutations that were applied to resources after a certain point in time.
Query Parameters
Earliest timestamp for mutation retrieval.
- 200
- 400
- 401
- 403
- 404
- 422
- 429
- 500
- 502
- 503
- 504
Request has been handled successfully.
Schema
- Array [
- ]
data object
Response schema for get mutations endpoint
mutations object[] required
Array of mutations that occurred after lastSyncedAt
Possible values: [CREATE
, UPDATE
, DELETE
]
The type of the mutation
Possible values: [BOOKMARK
, COLLECTION
, COLLECTION_BOOKMARK
, READING_SESSION
, PREFERENCE
, NOTE
]
The resource the mutation was applied to.
The id of the resource the mutation was applied to. Will not be present if the mutation was applied to certain resource without specific ID e.g. Preference.
data object
The latest version of the data of the resource that was mutated
Unix timestamp when the latest mutation of the resource occurred
Timestamp of the latest mutation. This should be used for subsequent sync requests. If the value is -1, it means no mutations happened since lastSyncedAt.
{
"success": true,
"data": {
"mutations": [
{
"type": "CREATE",
"resource": "BOOKMARK",
"resourceId": "lqc794i0qnxq4pdlfanfbd2r",
"data": {
"bookmarkType": "ayah",
"bookmarkGroup": "verses_6236",
"key": 6,
"verseNumber": 3
},
"timestamp": 1731636500303
}
],
"newLastSyncedAt": 1731636500303
}
}
The request is missing required parameters or is invalid.
Schema
{
"message": "The request is missing required headers or is invalid",
"type": "invalid_request",
"success": false
}
The request is unauthorized.
Schema
{
"message": "The request requires user authentication",
"type": "unauthorized",
"success": false
}
Forbidden error. Can either be due to access token not being passed, having been expired or the caller trying to access a resource without enough permissions.
Schema
{
"message": "The server understood the request, but refuses to authorize it",
"type": "forbidden",
"success": false
}
Not Found. The resource being accessed does not exist.
Schema
{
"message": "The requested resource could not be found",
"type": "not_found",
"success": false
}
Validation Error. The request includes one or more invalid params. Please check the request params and try again.
Schema
{
"message": "The request was well-formed but was unable to be followed due to semantic errors",
"type": "unprocessable_entity",
"success": false
}
Too many requests, please try again later.
Schema
{
"message": "Too many requests, please try again later",
"type": "rate_limit_exceeded",
"success": false
}
Server Error. Something went wrong, try again later.
Schema
{
"message": "The server encountered an internal error and was unable to complete your request",
"type": "internal_server_error",
"success": false
}
Invalid response from the upstream server
Schema
{
"message": "The server was acting as a gateway or proxy and received an invalid response from the upstream server",
"type": "bad_gateway",
"success": false
}
The server is currently unable to handle the request due to a temporary overload or scheduled maintenance
Schema
{
"message": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance",
"type": "service_unavailable",
"success": false
}
The server did not receive a timely response from the upstream server.
Schema
{
"message": "The server was acting as a gateway or proxy and did not receive a timely response from the upstream server",
"type": "gateway_timeout",
"success": false
}