Skip to main content
The Workspaces API provides access to your organization’s Workspace — the top-level container for all your documents, templates, members, and Spaces in Lumin.

​
Key concepts

  • Workspace — the top-level organizational unit. Every API key or OAuth token is scoped to a single Workspace.
  • Member — a user who belongs to the Workspace. Members can have different roles (owner, admin, member) that determine their permissions.
  • Space — a sub-group within a Workspace used to organize members and documents. Spaces allow teams to collaborate on separate sets of documents while sharing the same Workspace billing and settings.

​
Typical workflow

  1. Get Workspace info to retrieve the Workspace name, plan, and settings.
  2. List members to see who has access and their roles.
  3. List or create Spaces to organize teams and their documents within the Workspace.

​
Available endpoints

Get Workspace Information

Return information of the authorized Workspace.

Get Workspace Members

Return a paginated list of members in a Workspace.

List Spaces

Return a paginated list of Spaces within the authorized Workspace.

Create Space

Create a new Space within the authorized Workspace.