Agency
Invite members to workspaces
Invite one or many emails to one/many/all agency workspaces (targetOrgIds: "all"). Existing Octolens accounts get direct membership grants (no email — action: granted). New users receive exactly ONE invitation email for their first selected workspace (action: invited); every additional workspace is queued (action: queued) and granted automatically once the account exists. Combined fan-out (emails × workspaces) is capped at 200 per call.
POST
/
api
/
v2
/
agency
/
members
/
invite
Invite members to workspaces
curl --request POST \
--url https://app.octolens.com/api/v2/agency/members/invite \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"targetOrgIds": "all",
"emails": [
"jsmith@example.com"
],
"role": "org:member"
}
'import requests
url = "https://app.octolens.com/api/v2/agency/members/invite"
payload = {
"targetOrgIds": "all",
"emails": ["jsmith@example.com"],
"role": "org:member"
}
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({targetOrgIds: 'all', emails: ['jsmith@example.com'], role: 'org:member'})
};
fetch('https://app.octolens.com/api/v2/agency/members/invite', 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.octolens.com/api/v2/agency/members/invite",
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([
'targetOrgIds' => 'all',
'emails' => [
'jsmith@example.com'
],
'role' => 'org:member'
]),
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://app.octolens.com/api/v2/agency/members/invite"
payload := strings.NewReader("{\n \"targetOrgIds\": \"all\",\n \"emails\": [\n \"jsmith@example.com\"\n ],\n \"role\": \"org:member\"\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://app.octolens.com/api/v2/agency/members/invite")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"targetOrgIds\": \"all\",\n \"emails\": [\n \"jsmith@example.com\"\n ],\n \"role\": \"org:member\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octolens.com/api/v2/agency/members/invite")
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 \"targetOrgIds\": \"all\",\n \"emails\": [\n \"jsmith@example.com\"\n ],\n \"role\": \"org:member\"\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"orgId": "<string>",
"email": "<string>",
"success": true,
"action": "granted",
"error": "<string>"
}
]
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}Authorizations
Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>.
Body
application/json
Allowed value:
"all"Required array length:
1 - 50 elementsPattern:
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Available options:
org:member, org:admin Response
200 response
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Invite members to workspaces
curl --request POST \
--url https://app.octolens.com/api/v2/agency/members/invite \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"targetOrgIds": "all",
"emails": [
"jsmith@example.com"
],
"role": "org:member"
}
'import requests
url = "https://app.octolens.com/api/v2/agency/members/invite"
payload = {
"targetOrgIds": "all",
"emails": ["jsmith@example.com"],
"role": "org:member"
}
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({targetOrgIds: 'all', emails: ['jsmith@example.com'], role: 'org:member'})
};
fetch('https://app.octolens.com/api/v2/agency/members/invite', 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.octolens.com/api/v2/agency/members/invite",
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([
'targetOrgIds' => 'all',
'emails' => [
'jsmith@example.com'
],
'role' => 'org:member'
]),
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://app.octolens.com/api/v2/agency/members/invite"
payload := strings.NewReader("{\n \"targetOrgIds\": \"all\",\n \"emails\": [\n \"jsmith@example.com\"\n ],\n \"role\": \"org:member\"\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://app.octolens.com/api/v2/agency/members/invite")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"targetOrgIds\": \"all\",\n \"emails\": [\n \"jsmith@example.com\"\n ],\n \"role\": \"org:member\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octolens.com/api/v2/agency/members/invite")
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 \"targetOrgIds\": \"all\",\n \"emails\": [\n \"jsmith@example.com\"\n ],\n \"role\": \"org:member\"\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"orgId": "<string>",
"email": "<string>",
"success": true,
"action": "granted",
"error": "<string>"
}
]
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}