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"
}
'
import requests

url = "https://api.opnform.com/open/workspaces/{workspaceId}/users/add"

payload = { "email": "jsmith@example.com" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: 'jsmith@example.com'})
};

fetch('https://api.opnform.com/open/workspaces/{workspaceId}/users/add', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.opnform.com/open/workspaces/{workspaceId}/users/add",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => 'jsmith@example.com'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.opnform.com/open/workspaces/{workspaceId}/users/add"

payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.opnform.com/open/workspaces/{workspaceId}/users/add")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.opnform.com/open/workspaces/{workspaceId}/users/add")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"jsmith@example.com\"\n}"

response = http.request(request)
puts response.read_body

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