Skip to main content
POST
Create a workspace

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required

The unique identifier of the company.

Body

V2 API: Uses flat structure with separate members and groups fields

name
string
required
description
string
required
members
integer[]
groups
integer[]
document_upload_method
enum<string>
default:manual

Method for adding documents to this workspace

  • manual - manual
  • synced - synced
Available options:
manual,
synced

Response

201 - application/json

Mixin providing get_membership_role method for workspace serializers.

id
integer
required
name
string
required
workspace_type
string
required
document_upload_method
string
required
description
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
summaries
object[]
required
user_role
string | null
required
read-only

Return the user's highest role in the workspace (owner, editor, viewer) or None if not a member.

When a user is a member of the workspace through multiple groups (e.g., their private group and a company group), this returns the highest role among all their memberships. Role hierarchy: owner > editor > viewer

collection
object
required