Skip to main content
GET
/
v1
/
books
/
{id}
Get a book
curl --request GET \
  --url https://api.slant.app/v1/books/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "abc123xyz",
  "name": "John's Book",
  "role": "principal",
  "users": [
    {
      "id": "abc123xyz",
      "email": "user@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "role": "contributor",
      "api_access": {
        "auth_type": "personal_access_token",
        "scope": "read_write"
      }
    }
  ],
  "tiers": [
    {
      "value": 1,
      "label": "A-tier"
    }
  ],
  "teams": [
    {
      "id": "<string>",
      "name": "Advisory Team"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.slant.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 Bearer Token from Clerk authentication

Path Parameters

​
id
string
required

The book ID

Response

successful

​
id
string
required

The ID of the book

Example:

"abc123xyz"

​
name
string
required

The name of the book

Example:

"John's Book"

​
role
enum<string> | null
required

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

Available options:
principal,
contributor,
viewer
Example:

"principal"

​
users
object[]
required

Users with access to this book

​
tiers
object[]
required

Available tier labels for households in this book

​
teams
object[]
required

Teams in the book's company