curl --request POST \
--url https://app.famulor.io/api/v1/workspaces/{workspace_id}/api-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Customer backend",
"scopes": [
"calls:read",
"leads:write"
],
"expires_in_days": 90
}
'import requests
url = "https://app.famulor.io/api/v1/workspaces/{workspace_id}/api-keys"
payload = {
"name": "Customer backend",
"scopes": ["calls:read", "leads:write"],
"expires_in_days": 90
}
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({
name: 'Customer backend',
scopes: ['calls:read', 'leads:write'],
expires_in_days: 90
})
};
fetch('https://app.famulor.io/api/v1/workspaces/{workspace_id}/api-keys', 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.famulor.io/api/v1/workspaces/{workspace_id}/api-keys",
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([
'name' => 'Customer backend',
'scopes' => [
'calls:read',
'leads:write'
],
'expires_in_days' => 90
]),
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.famulor.io/api/v1/workspaces/{workspace_id}/api-keys"
payload := strings.NewReader("{\n \"name\": \"Customer backend\",\n \"scopes\": [\n \"calls:read\",\n \"leads:write\"\n ],\n \"expires_in_days\": 90\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.famulor.io/api/v1/workspaces/{workspace_id}/api-keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Customer backend\",\n \"scopes\": [\n \"calls:read\",\n \"leads:write\"\n ],\n \"expires_in_days\": 90\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/workspaces/{workspace_id}/api-keys")
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 \"name\": \"Customer backend\",\n \"scopes\": [\n \"calls:read\",\n \"leads:write\"\n ],\n \"expires_in_days\": 90\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"prefix": "<string>",
"scopes": [
"<string>"
],
"principal_type": "user",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"key": "fam_live_a1b2c3d4e5f6...",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"reason": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid API key."
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"reason": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"reason": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"reason": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the indicated delay."
}
}{
"error": {
"code": "internal_error",
"message": "Request protection is temporarily unavailable."
}
}Create an API key for a workspace
Mints a service-account API key bound to the selected workspace. The calling credential must be user-owned, carry settings:write, and its user must currently be an owner or admin in the target workspace. The target must be visible within the calling credential’s brand; no white-label entitlement is required. Requested scopes can only stay equal to or become narrower than the calling credential’s scopes. A child key cannot outlive a finite calling credential. The target may still be awaiting plan activation, but a suspended target is rejected. The plaintext key is returned exactly once with Cache-Control: no-store; do not retry automatically because each successful request creates a new key.
curl --request POST \
--url https://app.famulor.io/api/v1/workspaces/{workspace_id}/api-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Customer backend",
"scopes": [
"calls:read",
"leads:write"
],
"expires_in_days": 90
}
'import requests
url = "https://app.famulor.io/api/v1/workspaces/{workspace_id}/api-keys"
payload = {
"name": "Customer backend",
"scopes": ["calls:read", "leads:write"],
"expires_in_days": 90
}
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({
name: 'Customer backend',
scopes: ['calls:read', 'leads:write'],
expires_in_days: 90
})
};
fetch('https://app.famulor.io/api/v1/workspaces/{workspace_id}/api-keys', 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.famulor.io/api/v1/workspaces/{workspace_id}/api-keys",
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([
'name' => 'Customer backend',
'scopes' => [
'calls:read',
'leads:write'
],
'expires_in_days' => 90
]),
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.famulor.io/api/v1/workspaces/{workspace_id}/api-keys"
payload := strings.NewReader("{\n \"name\": \"Customer backend\",\n \"scopes\": [\n \"calls:read\",\n \"leads:write\"\n ],\n \"expires_in_days\": 90\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.famulor.io/api/v1/workspaces/{workspace_id}/api-keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Customer backend\",\n \"scopes\": [\n \"calls:read\",\n \"leads:write\"\n ],\n \"expires_in_days\": 90\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/workspaces/{workspace_id}/api-keys")
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 \"name\": \"Customer backend\",\n \"scopes\": [\n \"calls:read\",\n \"leads:write\"\n ],\n \"expires_in_days\": 90\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"prefix": "<string>",
"scopes": [
"<string>"
],
"principal_type": "user",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"key": "fam_live_a1b2c3d4e5f6...",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"reason": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid API key."
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"reason": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"reason": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"reason": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the indicated delay."
}
}{
"error": {
"code": "internal_error",
"message": "Request protection is temporarily unavailable."
}
}Authorizations
API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.