v1

latestOpenAPI 3.0.12026-07-268028223.9 KB
Books

List books

List all books the authenticated user has access to

get/v1/books

Query parameters

pageinteger

Page number

per_pageinteger

Items per page (1-100, default: 25). Values over 100 will be clamped to 100.

Response

successful

Example response

{
  "data": [
    {
      "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"
        }
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 10,
    "total_count": 100,
    "per_page": 25
  }
}