Skip to main content
POST
/
open
/
workspaces
/
{workspaceId}
/
users
/
add
Add Workspace User
curl --request POST \
  --url https://api.opnform.com/open/workspaces/{workspaceId}/users/add \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com"
}
'

​
Add Workspace User

Invite an existing OpnForm user to a workspace or send an email invite if the user doesn’t yet have an account.
Self-hosted Community instances are limited to 2 users total across the whole instance. Adding or inviting a new user beyond that limit requires a self-hosted Enterprise license. Adding an existing instance user to another workspace does not consume an additional user seat.

​
Authentication & Scope

Requires the workspace-users-write ability and admin privileges in the workspace.

​
Request

POST /open/workspaces/{workspaceId}/users/add HTTP/1.1
Host: api.opnform.com
Content-Type: application/json
Authorization: Bearer <token>

​
Path Parameters

ParameterTypeDescription
workspaceIdnumberID of the target workspace.

​
Body Parameters

FieldTypeRequiredDescription
emailstringYesEmail address of the user to add/invite.
rolestringYesRole to assign (admin, user, or readonly).
Example: 
{
  "email": "jane@example.com",
  "role": "user"
}

​
Response

200 OK – One of the following messages:
  • "User has been successfully added to workspace." – when the user account already exists.
  • "Registration invitation email sent to user." – when an invitation email was sent.
  • "User is already in workspace." – if the user is already a member.
The response structure: 
{
  "message": "User has been successfully added to workspace."
}
403 Forbidden – Token lacks workspace-users-write, the requester has insufficient privileges, or the self-hosted Community instance has reached the 2-user limit.

Authorizations

​
Authorization
string
header
required

Personal Access Token

Path Parameters

​
workspaceId
string
required

Body

application/json
​
email
string<email>
required
​
role
enum<string>
required
Available options:
admin,
user,
readonly

Response

User added