Blissbook for Developers

Get the live, personalized Documents a person can see. Identify the person by email, employee ID, or Blissbook ID.

List the Events recorded for your organization, newest first, filtered by time range, type, category, actor, or subject. Results are paginated: pass the returned nextCursor to continue where the last page left off.

Export a Saved Report as a CSV file, using the columns, filters, and sort order saved with the report. Find the report id in its URL in Blissbook.

The same Signatures as the JSON endpoint, as a CSV file with one row per Signature.

List the Signatures on your Documents, oldest first, each with the Document and person who signed it and links to its PDFs. Filter by when they were signed to sync only what changed.

Render just the acknowledgement the person signed and return a temporary download link to the PDF. The link expires after seven days.

Render the Document as it was signed and return a temporary download link to the PDF. The link expires after seven days.

Read the live, personalized content for the current user OR the person identified in asPerson.

List the live, personalized content for the current user OR the person identified in asPerson.

Search the live, personalized content for the current user OR the person identified in asPerson.

Copy Model Policies into the organization's Policy Library as draft policies, each linked to the Model Policy it came from so it receives updates. A Model Policy the organization already copied is skipped.

Archive document properties or an agency's client properties, so they are no longer listed or set. Their values are kept, and they can be unarchived in Blissbook.

Create a document of chapters from Model Policies: each chapter is a heading followed by its policies. A Model Policy is copied into the organization's Policy Library as a draft policy, linked to the Model Policy so it receives updates, unless the organization already copied it, in which case the document references its copy.

Create draft policies for the organization, optionally setting property values, the References they cite, and, for a Model Policy, the clients it is for. Always ask the user for HTML content before creating.

Create a property: one set on documents of the given types, like a policy owner or category, or one of an agency's client properties: a fact it keeps about each client, like their industry, which a Model Policy's clients expression matches on. Set its values with the set properties tools.

Read the organization's demographics: how many people it has in each country, state, county, and city, with the synced count and the manually recorded count behind each number. These counts decide which jurisdictions its policies need to cover.

Read one Model Policy in full: its published HTML, the notes explaining what to decide before adopting it, and the jurisdiction and topic it is classified under. Find ids with list_model_policies.

Read policies in full: the draft and last published version of each one, the notes anchored in their content, and the property values set on them. Find ids with list_policies.

Read policy skills in full: the published rules the AI Check reviews policies against. Follow them when writing or editing policies so the result matches the organization’s house style. Find ids with list_policy_skills.

List your agency's client properties — each with its id, label, type, the question it asks when it has one, and the options a select property offers — with your organization's value for each. Set them with set_client_properties. For clients of an agency.

Search the organization's Documents (the handbooks people read and sign) by name, with who can see each one and the policies it includes, each with its own audience. A person can read a policy in a Document when they are in the Document's audience and in the policy's. To see which Documents a person can see, use list_people.

Search the organization's groups by name. Put a group's id in a groups operand to make an audience of its members.

List the Model Policies available to the organization — Blissbook-maintained policy templates — each with the jurisdiction it applies to, how it is classified, and whether it applies to the organization. Returns names and properties only; read one in full with get_model_policy, and copy the ones that apply with add_model_policies.

Search the organization's people by name, email, or employee ID, with each person's people property values and whether their signature is required: overall, and on each Document they can see. Put a person's id in a people operand to make an audience of them.

Search the organization's policies by name, the location they apply to, the property values set on them, and whether they have an audience (access control). Returns a page of policies with their properties, publish state, audience, Direct Distribution, and collaborators, but not their content — read that with get_policies.

List the organization's policy skills: the writing rules its AI Check reviews policies against. Only skills in effect are listed — published and not archived. Returns names only; read the rules with get_policy_skills.

List the variables these Model Policies use, such as the company name or the first day of the year, each with the organization's value, absent when it has none yet. Fill in the ones without a value with set_policy_variables.

List the properties that can be set on the given target types (e.g. policies, law changes, clients, people) — each with its id, label, definition, type, the target types it applies to, and the options a select property offers. Pass the ids to the list, create, and set properties tools. A person's properties are the people metadata keys and their values, which a metadata operand in an audience matches on. An agency's client properties (organization) are what it keeps about each client, which a policy's clients expression matches on.

Search the organization's saved segments by name, with the filter each one saves. Put a segment's id in a savedSegments operand to make an audience of whoever matches it.

Check a policy draft against the law where it applies and Blissbook's writing guidance, and return the edits the check recommends. By default the recommendations are left on the draft as suggestions an author can accept or reject; pass analysisMode: null to preview them without touching the policy.

Search the draft (unpublished) content for the current user, the person identified in asPerson, or ALL of the content in the organization.

Search Blissbook's help center for how to use Blissbook: how to do something, what a setting does, or where to find a feature. Each article comes with its text and the url to read it at.

Set or clear client property values. A client of an agency answers the client properties its agency asks about; an agency sets any of its client properties on its clients, named by organizationIds, all at once. Returns each client with its client property values after the change.

Set the same property values on one or more existing policies, along with the location they apply to, the References they cite, and, for a Model Policy, the clients it is for. Use list_policies to find policy ids and list_properties to find property ids. Existing values for the given properties are replaced, or pass unset: true on an entry to clear it.

Update the manual people counts on the organization's demographics. Locations not listed keep their counts, and a null count reverts that location to the count calculated from synced people. Pass removeExisting: true to clear every existing manual count before applying the inserts.

Surgically edit a policy draft's HTML without replacing the whole document, anchored to the block ids in the draft HTML (from get_policies): replaceText swaps a snippet of visible text within one block (formatting is preserved), replaceBlocks overwrites whole blocks with new HTML, insertBlocks adds new blocks beside an anchor block, deleteBlocks removes blocks, and wrapInReadMore/unwrapReadMore restructure collapsible Read More sections. By default the operations are applied directly to the draft; pass suggest: true to record them as tracked suggestions an author can accept or reject. Pass annotations to create notes anchored in the content the operations write, which the direct edit requires. The draft stays unpublished either way.

Update a policy, law change, or client property: optionally set a new label, and remove (pull), replace (set), move, or add (push) select options individually.

List the organization's events — sign-ins, permission and account changes, data exports, and document activity — filtered by time range, event type, category, actor, or subject. Results are paginated: pass the returned nextCursor to continue.

How each of the organization's people sync integrations is doing: our record of its last sync and counts, plus, for Merge.dev integrations, what Merge reports live about the linked account, its open issues and its last pull of each data model from the HRIS.

Trace one person through the organization's people sync to find where they drop out: the HRIS record as the sync provider last pulled it, the row the last sync produced from it with any quarantine or exclusion, and the Blissbook person it became. An empty result means the HRIS never sent the person, so they may have been added to Blissbook by hand (see list_people). For a person's Documents and signature status, use list_people.