SLslant
Books

Get a book

Changed on

Retrieve a book by ID

get/v1/books/{id}

Request

  • Base URL
    https://api.slant.app
  • URL
    https://api.slant.app/v1/books/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The book ID

Response

successful

idstring required

The ID of the book

namestring required

The name of the book

role'principal' | 'contributor' | 'viewer' nullable required

The authenticated user's role in this book. Null for admin users accessing books without an explicit BookUser record.

Example response

{
  "id": "abc123xyz",
  "name": "John's Book",
  "role": "principal",
  "users": [
    {
      "id": "abc123xyz",
      "email": "user@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "api_access": {
        "auth_type": "personal_access_token",
        "scope": "read_write"
      },
      "role": "contributor"
    }
  ],
  "tiers": [
    {
      "value": 1,
      "label": "A-tier"
    }
  ],
  "teams": [
    {
      "name": "Advisory Team"
    }
  ]
}

Changes

  • 173c41bf6be9Revision changes
    • breaking

      the response property /////// became nullable for the status

    • warning

      added the new oauth enum value to the /////// response property for the response status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      removed the invalid_json enum value from the response property for the response status

    • info

      response property detail list-of-types was narrowed by removing types array from media type application/json of response 400