Organization & User Administration Managing the Organization Lifecycle

Whether you are setting up a brand new workspace or managing an existing team, your organization is the central hub for all your work. This guide will walk you through the complete lifecycle of an organization—from initial creation and onboarding to inviting team members and updating settings.

Automate with the API

Everything you can do in the dashboard can also be automated using our REST API. Check the developer reference at the bottom of this page for endpoint details.

The Organization Lifecycle

Managing an organization typically follows a straightforward path. You start by creating the workspace, customizing it, inviting your team, and eventually maintaining its settings over time.

flowchart TD
    A[Create Organization] --> B[Complete Onboarding]
    B --> C["Upload Logo & Branding"]
    B --> D[Invite Team Members]
    D --> E["Manage Roles & Access"]
    C --> F{Active Organization}
    E --> F
    F --> G[Update Details]
    F --> H[Delete Organization]

Setting up your organization

Getting a new organization off the ground only takes a few steps.

  1. 1

    Create the organization

    Start by creating a new organization workspace. This will serve as the top-level container for all your projects, settings, and team members.

  2. 2

    Complete onboarding

    Once created, you will be prompted to complete the onboarding process. This ensures your organization has all the required profile information to function properly.

  3. 3

    Customize your branding

    Upload your company logo to personalize the workspace. This logo will appear in your team's dashboard and on any shared external documents.

We recommend uploading a square logo (at least 400x400 pixels) in PNG or SVG format for the best display quality across the platform.

Managing your team

Once your organization is set up, you can bring your team on board. You have full control over who has access and what they can do.

ActionDescription
Invite UsersSend email invitations to bring new collaborators into your organization.
Track InvitationsView a list of all pending invites that haven't been accepted yet.
View Active UsersSee a complete list of everyone who currently has access to your workspace.
Update RolesChange a user's permission level (e.g., promote a standard user to an administrator).
Remove UsersInstantly revoke workspace access for users who no longer need it.

When you invite a user, they will receive a notification and see the invite in their Pending Invitations list. They must explicitly accept the invitation to join your active user list.

Updating and deleting

As your company evolves, your organization settings might need to change. You can update your organization's details (like its name or billing email) at any time.

If you ever need to completely shut down a workspace, you can delete the organization.

Deleting an organization is permanent and cannot be undone. All associated projects, user access, and data will be permanently erased. Proceed with extreme caution.

For Developers: API Reference

If you are building custom internal tools or automating your administration, you can manage the entire organization lifecycle via our API.

Organization Management Endpoints

Use these endpoints to manage the core organization entity:

  • GET /v1/organization - Get all organizations for the current user

  • POST /v1/organization - Create a new organization

  • GET /v1/organization/{organization_id} - Get organization details by ID

  • PUT /v1/organization/{organization_id} - Update organization details

  • DELETE /v1/organization/{organization_id} - Delete an organization

  • POST /v1/organization/{organization_id}/complete-onboarding - Complete the onboarding flow

  • POST /v1/organization/{organization_id}/upload-logo - Upload a custom logo

  • GET /v1/organization/all - List all organizations (Admin only)

User Management Endpoints

Use these endpoints to manage access and roles:

  • GET /v1/invitations - List your pending invitations

  • POST /v1/invitations/{invitation_id}/accept - Accept an invitation

  • GET /v1/organization/{organization_id}/user - Get all users in the organization

  • GET /v1/organization/{organization_id}/user/active - Get only active users

  • GET /v1/organization/{organization_id}/user/pending - Get pending invites

  • POST /v1/organization/{organization_id}/user/invite - Invite a new user

  • PATCH /v1/organization/{organization_id}/user/{user_id}/role - Update a user's role

  • DELETE /v1/organization/{organization_id}/user/{user_id} - Remove a user

Customer Admin & Internal Endpoints

Use these endpoints for administrative oversight and internal subscription management:

  • GET /v1/admin/customers - List all customers (admin)

  • GET /v1/admin/customers/{organization_id} - Get customer overview (admin)

  • GET /v1/admin/customers/export - Export customers as CSV (admin)

  • POST /internal/subscriptions/{organization_id}/toggle-active - Toggle documentations active for an org (S2S)