GET/spaces/api/v1/requiredreading/spaces/{spaceID}/pages/{pageID}/status.json

Retrieves the current Required Reading status of a page for a user.

This will include the version the user has last read (if any) and the current version of the page. This can assist when looking to get a diff of what has changed from last read.

Path Params

  • Name
    spaceID
    Type
    integer
    required
    Description
  • Name
    pageID
    Type
    integer
    required
    Description

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
  • Code
    404
    Type
    object
    Schema
    Description
    404 Not Found
  • Code
    500
    Type
    object
    Schema
    Description
    500 Internal Server Error

Examples

200 OK

Read
{
  "requiredReading": {
    "latestVersion": 0,
    "readVersion": 0,
    "state": "read"
  }
}