List Handbooks

List all handbooks for the authenticated user. Returns handbooks belonging to the authenticated user.

Query

query ListHandbooks($filter: ListHandbooksFilter) {
  listHandbooks(filter: $filter) {
    handbooks {
      handbookId
      handbookType
      createdAt
      updatedAt
      companyName
      industry
    }
    total
  }
}

Parameters

Parameter	Type	Required	Description
filter	ListHandbooksFilter	No	Filters for pagination. All fields are optional.

ListHandbooksFilter Input

Field	Type	Description
limit	Int	Maximum number of handbooks to return. Defaults to 50. Maximum is 100.
offset	Int	Number of handbooks to skip for pagination. Defaults to 0.

Response

{
  "data": {
    "listHandbooks": {
      "handbooks": [
        {
          "handbookId": 123,
          "handbookType": "comprehensive",
          "createdAt": "2025-01-01T00:00:00Z",
          "updatedAt": "2025-01-15T10:30:00Z",
          "companyName": "Acme Corporation",
          "industry": "PROFESSIONAL"
        },
        {
          "handbookId": 124,
          "handbookType": "basic",
          "createdAt": "2025-01-02T00:00:00Z",
          "updatedAt": null,
          "companyName": "Tech Startup Inc",
          "industry": "other"
        }
      ],
      "total": 25
    }
  }
}

Examples

Get All Handbooks (Default)

query {
  listHandbooks {
    handbooks {
      handbookId
      handbookType
      createdAt
      companyName
    }
    total
  }
}

With Pagination

query {
  listHandbooks(filter: { limit: 25, offset: 0 }) {
    handbooks {
      handbookId
      handbookType
      createdAt
      companyName
      industry
    }
    total
  }
}

Variables

{
  "filter": {
    "limit": 25,
    "offset": 0
  }
}

Response Fields

HandbooksList

Field	Type	Description
handbooks	[HandbookListItem!]!	Array of handbook metadata records (does not include content)
total	Int!	Total number of handbooks matching the query (before pagination)

HandbookListItem

Field	Type	Description
handbookId	Int!	Unique identifier for the handbook
handbookType	String!	Type of handbook: "basic" or "comprehensive"
createdAt	String!	ISO 8601 timestamp when the handbook was created
updatedAt	String	ISO 8601 timestamp when the handbook was last updated
companyName	String	Company name from the handbook data
industry	String	Industry type
subscriptionStatus	SubscriptionStatus	Subscription status of the handbook

Notes

• Requires bearer token authentication
• Maximum limit is 100. If exceeded, it will be capped at 100
• Results are ordered by creation date (newest first)
• The response does not include handbook content. Use getHandbook to retrieve full handbook with content
• Only returns handbooks belonging to the authenticated user
• For detailed information about response types and fields, see Types & Schema