Types Overview

The Handbooks GraphQL API uses a comprehensive type system to represent handbooks, customers, policy updates, and more. This section provides an overview of all available types.

Core Types

Handbook Types

• Handbook - Full handbook with content and data
• HandbookListItem - Lightweight handbook metadata for lists
• HandbookListItemReseller - Reseller version with customer info
• HandbookData - Input data used to generate a handbook
• HandbookResponse - Response from handbook generation

Version History Types

• HandbookVersionUser - User who created a version
• HandbookVersionListItem - Version metadata without content
• HandbookVersionsList - Paginated list of versions
• HandbookVersionDetail - Version with full content
• RestoreHandbookVersionResponse - Restore operation response
• UpdateHandbookContentResponse - Content update response
• TranslateHandbookResponse - Translation response

Customer Types

• Customer - Customer/SSO user information
• CustomersList - Paginated list of customers
• BearerTokenResponse - JWT token generation response

Signature Request Types

• SignatureSignee - A signee with signing status
• SignatureSigneesList - List of signees
• SendSignatureResponse - Send signature request response
• ResendSignatureResponse - Resend reminder response
• RemoveSignatureResponse - Remove request response

Policy Types

• PolicyFeedResponse - Response from policyFeed query
• PolicyUpdateItem - Policy and compliance update with full HTML content

Utility Types

• HealthCheck - API health status
• UpdateDefaultCustomerHandbookLimitResponse - Limit update response

Input Types

See Input Types for complete documentation of all input types:

• HandbookRequest - Input for generating handbooks
• CustomerInput - Input for creating customers
• CustomerUpdateInput - Input for updating customers
• PolicyFeedFilters - Filters for policy feed queries
• ListHandbooksFilter - Filters for listing handbooks
• ListHandbooksResellerFilter - Reseller filters for listing handbooks
• SignatureRecipientInput - Recipient for signature requests

Enums

See Enums for complete documentation:

• HandbookFormat - Output format options (HTML, DOCX, TXT)
• StateList - US state abbreviations
• HandbookType - Handbook type (BASIC, COMPREHENSIVE)

Scalar Types

• JSON - JSON scalar type for flexible data structures
• String - Standard string type
• Int - Integer type
• Boolean - Boolean type

Type Relationships

Customer
  ├── Has many Handbooks
  └── Has customerHandbookLimit

Handbook
  ├── Belongs to Customer
  ├── Contains HandbookData
  ├── Has HandbookResponse when generated
  ├── Has many HandbookVersions
  └── Has many SignatureSignees

HandbookData
  ├── Contains company information
  ├── Contains employment policies
  ├── Contains benefits configuration
  └── Contains custom policies

Next Steps

• Explore Handbook Types for detailed handbook structure
• Review Customer Types for customer management
• Check Input Types for mutation inputs
• See Enums for available enum values

PolicyFeedResponse

Response from the policyFeed query containing policy updates.

Field	Type	Description
total	Int!	Total number of policy updates found
policyUpdates	[PolicyUpdateItem!]!	Array of policy updates with full HTML content

PolicyUpdateItem

Represents a single policy or compliance update with full HTML content ready for insertion into handbooks.

Field	Type	Description
date	String!	The date of the update in YYYY-MM-DD format
month	Int!	Month of the update (1-12)
year	Int!	Year of the update
scope	String!	State code (e.g., CA, NY, TX) or US for federal updates that apply to all states
title	String!	Title of the policy update
content	String!	Full HTML content of the policy update ready to be inserted into a handbook
summary	String	Brief summary of the policy update from the related compliance update
instructions	String	Instructions for how to apply this update to your handbook
conditions	String	Context about when/why this update applies

HealthCheck

Simple object used by the health query.

Field	Type	Description
status	String!	Status string such as ok
timestamp	String!	ISO timestamp when the health check was generated

UpdateDefaultCustomerHandbookLimitResponse

Response returned when updating reseller handbook limits.

Field	Type	Description
limit	Int!	Updated global handbook limit
usersUpdated	Int	Number of users whose custom limits were updated (if applicable)