All resourcesGuidesCoursesTips

5 min read

Boost admin capabilities with our API

The Superhuman Docs Admin API allows Enterprise org admins to sync data and admin controls into a doc via Packs letting you view data or build a full, custom admin app.

Lightbulb icon
This feature is only available to Enterprise plans.
If you manage Superhuman Docs for your organization, the Admin API gives you another way to work with the same data and controls available in your admin settings, but with more flexibility. This guide walks you through how to access the Admin API, when to use it instead of the in-product control, and a few examples to help you get started.
What you'll get:
  • What the Admin API is, and when to use it
  • How to access the Admin Pack
buttons
What you'll use:
  • Admin API Pack
  • Org admin settings

1. How to access the Admin API

 The Superhuman Docs Admin API is available to Superhuman Docs admins to access user data, and Superhuman Docs workspace and organization controls. It is intended to work in tandem with the in-product controls you are already familiar with. To access the API, we recommend using the Superhuman Docs Admin Pack, which acts as a UI layer to the API. You can use the Pack to view data, or build a full custom admin app with automations, notifications, and more.

2. When to use in-product controls versus Admin API

 The in-product control panel and the Superhuman Docs Admin API are fantastic ways to view and action data. Depending on the complexity of your task, you may opt for one over the other.

In-product control panel

 The in-app workspace settings and organization settings control panel are the most convenient places to view org info and user info, adjust security settings, and configure settings.

Use the in-product controls to...

  • Manage members and see usage analytics for workspace members.
  • See and transfer docs owned by deactivated users.
  • See and manage AI usage.

Superhuman Docs Admin API

 For building custom use cases, we recommend using the Superhuman Docs API via the Superhuman Docs Admin Pack. The Pack acts like a UI layer to the Admin API and gives admins real-time information on users, docs, folders, Packs, and activity in their organization. If you want to connect to the API directly check out the Admin API documentation for details on the correct endpoints (and more).

Use the Admin API to:

  • Export information on users, docs, Packs, and folders for detailed analysis.
  • View all the docs that have Packs in them.
  • Export audit logs (you can see this in-product but need to use the Pack to export).
  • See all folders in the org.

3. What you can build with the Admin Pack

 The Admin Pack can be as simple or as advanced as you need. Here are a few examples of what's possible, each a step up in complexity:
  • Visualize your workspace: Pull in key org and user data to get a quick, readable view of what's happening across your workspace.
  • Automate monitoring: Set up automations that flag things like inactive users, unused Packs, or docs nearing read-only status, so you're not checking manually.
  • Build a custom admin app: Combine data views, automations, and buttons to create a fully custom admin tool inside a Superhuman Doc, tailored to exactly how your org works.

Now what?

 The Admin API and Admin Pack are just one part of running Superhuman Docs at scale. Here are a few good next steps:

Was this helpful?

YesNo