Join a group via invite link
curl --request POST \
--url https://app.orgo.space/api/v1/group/join \
--header 'Api-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"role": "/api/v1/roles/1",
"user": "/api/v1/users/1",
"unit": "/api/v1/units/1",
"dateCreated": "2026-01-15T10:30:00+00:00",
"dateEnded": "2026-01-15T10:30:00+00:00",
"isAdmin": true,
"localCenterPermission": "string",
"import": "/api/v1/imports/1"
}
'import requests
url = "https://app.orgo.space/api/v1/group/join"
payload = {
"role": "/api/v1/roles/1",
"user": "/api/v1/users/1",
"unit": "/api/v1/units/1",
"dateCreated": "2026-01-15T10:30:00+00:00",
"dateEnded": "2026-01-15T10:30:00+00:00",
"isAdmin": True,
"localCenterPermission": "string",
"import": "/api/v1/imports/1"
}
headers = {
"Api-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Api-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
role: '/api/v1/roles/1',
user: '/api/v1/users/1',
unit: '/api/v1/units/1',
dateCreated: '2026-01-15T10:30:00+00:00',
dateEnded: '2026-01-15T10:30:00+00:00',
isAdmin: true,
localCenterPermission: 'string',
import: '/api/v1/imports/1'
})
};
fetch('https://app.orgo.space/api/v1/group/join', 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://app.orgo.space/api/v1/group/join",
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([
'role' => '/api/v1/roles/1',
'user' => '/api/v1/users/1',
'unit' => '/api/v1/units/1',
'dateCreated' => '2026-01-15T10:30:00+00:00',
'dateEnded' => '2026-01-15T10:30:00+00:00',
'isAdmin' => true,
'localCenterPermission' => 'string',
'import' => '/api/v1/imports/1'
]),
CURLOPT_HTTPHEADER => [
"Api-Token: <api-key>",
"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://app.orgo.space/api/v1/group/join"
payload := strings.NewReader("{\n \"role\": \"/api/v1/roles/1\",\n \"user\": \"/api/v1/users/1\",\n \"unit\": \"/api/v1/units/1\",\n \"dateCreated\": \"2026-01-15T10:30:00+00:00\",\n \"dateEnded\": \"2026-01-15T10:30:00+00:00\",\n \"isAdmin\": true,\n \"localCenterPermission\": \"string\",\n \"import\": \"/api/v1/imports/1\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Api-Token", "<api-key>")
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://app.orgo.space/api/v1/group/join")
.header("Api-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"role\": \"/api/v1/roles/1\",\n \"user\": \"/api/v1/users/1\",\n \"unit\": \"/api/v1/units/1\",\n \"dateCreated\": \"2026-01-15T10:30:00+00:00\",\n \"dateEnded\": \"2026-01-15T10:30:00+00:00\",\n \"isAdmin\": true,\n \"localCenterPermission\": \"string\",\n \"import\": \"/api/v1/imports/1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.orgo.space/api/v1/group/join")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Api-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"role\": \"/api/v1/roles/1\",\n \"user\": \"/api/v1/users/1\",\n \"unit\": \"/api/v1/units/1\",\n \"dateCreated\": \"2026-01-15T10:30:00+00:00\",\n \"dateEnded\": \"2026-01-15T10:30:00+00:00\",\n \"isAdmin\": true,\n \"localCenterPermission\": \"string\",\n \"import\": \"/api/v1/imports/1\"\n}"
response = http.request(request)
puts response.read_body{
"id": 42,
"role": {
"id": 42,
"name": "Boston Chapter",
"namePlural": "Boston Chapter",
"unitType": "/api/v1/unit_types/1",
"position": 42,
"isUserType": true,
"options": [
"string"
],
"isLocalCenter": true,
"isLocalCenterParent": true,
"isNational": true,
"permissions": [
"string"
],
"chartName": "Boston Chapter",
"isNotEligibleForFee": true,
"isParent": true,
"isVolunteer": true
},
"user": {
"id": 42,
"firstName": "James",
"lastName": "Patterson",
"email": "james.patterson@example.com",
"status": "ACTIVE",
"type": {
"id": 42,
"name": "Boston Chapter",
"namePlural": "Boston Chapter",
"unitType": "/api/v1/unit_types/1",
"position": 42,
"isUserType": true,
"options": [
"string"
],
"isLocalCenter": true,
"isLocalCenterParent": true,
"isNational": true,
"permissions": [
"string"
],
"chartName": "Boston Chapter",
"isNotEligibleForFee": true,
"isParent": true,
"isVolunteer": true
},
"age": 34,
"fullName": "James Patterson",
"logo": "https://cdn.orgo.space/tenants/acme/logo.png",
"phoneNumber": "+1 415 555 0142",
"cardId": "string",
"validFeeDate": "2026-01-15T10:30:00+00:00",
"feeTenantProductPrice": "/api/v1/product_prices/1",
"postalCode": "02108",
"address": "123 Beacon Street",
"professionOrganisation": "Civic Collective",
"professionOrganisationWebsite": "https://civic-collective.example.com",
"professionOrganisationRole": "Civic Collective",
"companyIdentifier": "US-123456789",
"companyName": "Civic Collective LLC",
"companyAddress": "123 Beacon Street, Boston, MA 02108",
"companyRegNo": "DE-HRB-12345"
},
"unit": "/api/v1/units/1",
"dateCreated": "2026-01-15T10:30:00+00:00",
"dateEnded": "2026-01-15T10:30:00+00:00",
"isAdmin": true,
"localCenterPermission": "string"
}UserRole
Join a group via invite link
Allows the authenticated user to join a group via an invite link. The group must be marked as joinable and belong to the same tenant. Prevents duplicate membership. Sets the user as a regular member (no admin or role assignment).
POST
/
api
/
v1
/
group
/
join
Join a group via invite link
curl --request POST \
--url https://app.orgo.space/api/v1/group/join \
--header 'Api-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"role": "/api/v1/roles/1",
"user": "/api/v1/users/1",
"unit": "/api/v1/units/1",
"dateCreated": "2026-01-15T10:30:00+00:00",
"dateEnded": "2026-01-15T10:30:00+00:00",
"isAdmin": true,
"localCenterPermission": "string",
"import": "/api/v1/imports/1"
}
'import requests
url = "https://app.orgo.space/api/v1/group/join"
payload = {
"role": "/api/v1/roles/1",
"user": "/api/v1/users/1",
"unit": "/api/v1/units/1",
"dateCreated": "2026-01-15T10:30:00+00:00",
"dateEnded": "2026-01-15T10:30:00+00:00",
"isAdmin": True,
"localCenterPermission": "string",
"import": "/api/v1/imports/1"
}
headers = {
"Api-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Api-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
role: '/api/v1/roles/1',
user: '/api/v1/users/1',
unit: '/api/v1/units/1',
dateCreated: '2026-01-15T10:30:00+00:00',
dateEnded: '2026-01-15T10:30:00+00:00',
isAdmin: true,
localCenterPermission: 'string',
import: '/api/v1/imports/1'
})
};
fetch('https://app.orgo.space/api/v1/group/join', 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://app.orgo.space/api/v1/group/join",
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([
'role' => '/api/v1/roles/1',
'user' => '/api/v1/users/1',
'unit' => '/api/v1/units/1',
'dateCreated' => '2026-01-15T10:30:00+00:00',
'dateEnded' => '2026-01-15T10:30:00+00:00',
'isAdmin' => true,
'localCenterPermission' => 'string',
'import' => '/api/v1/imports/1'
]),
CURLOPT_HTTPHEADER => [
"Api-Token: <api-key>",
"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://app.orgo.space/api/v1/group/join"
payload := strings.NewReader("{\n \"role\": \"/api/v1/roles/1\",\n \"user\": \"/api/v1/users/1\",\n \"unit\": \"/api/v1/units/1\",\n \"dateCreated\": \"2026-01-15T10:30:00+00:00\",\n \"dateEnded\": \"2026-01-15T10:30:00+00:00\",\n \"isAdmin\": true,\n \"localCenterPermission\": \"string\",\n \"import\": \"/api/v1/imports/1\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Api-Token", "<api-key>")
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://app.orgo.space/api/v1/group/join")
.header("Api-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"role\": \"/api/v1/roles/1\",\n \"user\": \"/api/v1/users/1\",\n \"unit\": \"/api/v1/units/1\",\n \"dateCreated\": \"2026-01-15T10:30:00+00:00\",\n \"dateEnded\": \"2026-01-15T10:30:00+00:00\",\n \"isAdmin\": true,\n \"localCenterPermission\": \"string\",\n \"import\": \"/api/v1/imports/1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.orgo.space/api/v1/group/join")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Api-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"role\": \"/api/v1/roles/1\",\n \"user\": \"/api/v1/users/1\",\n \"unit\": \"/api/v1/units/1\",\n \"dateCreated\": \"2026-01-15T10:30:00+00:00\",\n \"dateEnded\": \"2026-01-15T10:30:00+00:00\",\n \"isAdmin\": true,\n \"localCenterPermission\": \"string\",\n \"import\": \"/api/v1/imports/1\"\n}"
response = http.request(request)
puts response.read_body{
"id": 42,
"role": {
"id": 42,
"name": "Boston Chapter",
"namePlural": "Boston Chapter",
"unitType": "/api/v1/unit_types/1",
"position": 42,
"isUserType": true,
"options": [
"string"
],
"isLocalCenter": true,
"isLocalCenterParent": true,
"isNational": true,
"permissions": [
"string"
],
"chartName": "Boston Chapter",
"isNotEligibleForFee": true,
"isParent": true,
"isVolunteer": true
},
"user": {
"id": 42,
"firstName": "James",
"lastName": "Patterson",
"email": "james.patterson@example.com",
"status": "ACTIVE",
"type": {
"id": 42,
"name": "Boston Chapter",
"namePlural": "Boston Chapter",
"unitType": "/api/v1/unit_types/1",
"position": 42,
"isUserType": true,
"options": [
"string"
],
"isLocalCenter": true,
"isLocalCenterParent": true,
"isNational": true,
"permissions": [
"string"
],
"chartName": "Boston Chapter",
"isNotEligibleForFee": true,
"isParent": true,
"isVolunteer": true
},
"age": 34,
"fullName": "James Patterson",
"logo": "https://cdn.orgo.space/tenants/acme/logo.png",
"phoneNumber": "+1 415 555 0142",
"cardId": "string",
"validFeeDate": "2026-01-15T10:30:00+00:00",
"feeTenantProductPrice": "/api/v1/product_prices/1",
"postalCode": "02108",
"address": "123 Beacon Street",
"professionOrganisation": "Civic Collective",
"professionOrganisationWebsite": "https://civic-collective.example.com",
"professionOrganisationRole": "Civic Collective",
"companyIdentifier": "US-123456789",
"companyName": "Civic Collective LLC",
"companyAddress": "123 Beacon Street, Boston, MA 02108",
"companyRegNo": "DE-HRB-12345"
},
"unit": "/api/v1/units/1",
"dateCreated": "2026-01-15T10:30:00+00:00",
"dateEnded": "2026-01-15T10:30:00+00:00",
"isAdmin": true,
"localCenterPermission": "string"
}Authorizations
ApiTokenJWT
Server-to-server authentication. Generate a token in the admin UI at
Settings → Developers → API Access. Send the raw token in the
Api-Token header — there is no Bearer prefix.
Tokens can be marked read-only at creation time, in which case the API
rejects any non-GET request with 403 Forbidden.
Body
application/json
The new UserRole resource
Example:
"/api/v1/roles/1"
Example:
"/api/v1/users/1"
Example:
"/api/v1/units/1"
Example:
"/api/v1/imports/1"
Response
UserRole resource created
⌘I