Workspace keys
List Workspace Keys
List workspace key/secret pairs for this workspace. Backend SDKs authenticate with a workspace key and secret (Suprsend(workspace_key, workspace_secret)).
Every response - including this list - returns the full key and secret in plain text. Handle the response as sensitive data.
GET
/
v1
/
{workspace}
/
ws_key
/
List Workspace Keys
curl -X GET "https://management-api.suprsend.com/v1/{workspace}/ws_key/" \
--header 'Authorization: ServiceToken <SERVICE_TOKEN>' \
--header 'Content-Type: application/json'import requests
url = "https://management-api.suprsend.com/v1/{workspace}/ws_key/"
headers = {"ServiceToken <token>": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'ServiceToken <token>': '<api-key>'}};
fetch('https://management-api.suprsend.com/v1/{workspace}/ws_key/', 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://management-api.suprsend.com/v1/{workspace}/ws_key/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"ServiceToken <token>: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://management-api.suprsend.com/v1/{workspace}/ws_key/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("ServiceToken <token>", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://management-api.suprsend.com/v1/{workspace}/ws_key/")
.header("ServiceToken <token>", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://management-api.suprsend.com/v1/{workspace}/ws_key/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["ServiceToken <token>"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"meta": {
"count": 2,
"limit": 10,
"offset": 0
},
"results": [
{
"id": "ws_key_01ABCDEFGHJKMNPQRSTVWXYZ0",
"name": "default",
"key": "SS.WSK.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"secret": "SS.WSS.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"is_default": true,
"is_active": true,
"is_deleted": false,
"allowed_domains": [],
"created_at": "2024-08-27T10:54:03.512045Z",
"created_by": null,
"rotated_at": null,
"rotated_by": null,
"deleted_at": null,
"deleted_by": null
},
{
"id": "ws_key_01ABCDEFGHJKMNPQRSTVWXYZ1",
"name": "ops-cli",
"key": "SS.WSK.YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY",
"secret": "SS.WSS.YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY",
"is_default": false,
"is_active": true,
"is_deleted": false,
"allowed_domains": [],
"created_at": "2026-09-28T11:12:23.557360Z",
"created_by": {
"name": "System User",
"email": "org_XXXXXXXXXXXXXXXXXXXXXX@systemuser.suprsend.com"
},
"rotated_at": null,
"rotated_by": null,
"deleted_at": null,
"deleted_by": null
}
]
}{
"code": 401,
"error_code": "authentication_failed",
"type": "AuthenticationFailed",
"message": "Invalid service token.",
"detail": "Invalid service token."
}{
"code": 404,
"error_code": "not_found",
"type": "NotFound",
"message": "workspace 'demo' not found",
"detail": "workspace 'demo' not found"
}Authorizations
You can get Service Token from SuprSend dashboard -> Account Settings -> Service Tokens section.
Path Parameters
Workspace slug (e.g. staging, production).
Was this page helpful?
⌘I
List Workspace Keys
curl -X GET "https://management-api.suprsend.com/v1/{workspace}/ws_key/" \
--header 'Authorization: ServiceToken <SERVICE_TOKEN>' \
--header 'Content-Type: application/json'import requests
url = "https://management-api.suprsend.com/v1/{workspace}/ws_key/"
headers = {"ServiceToken <token>": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'ServiceToken <token>': '<api-key>'}};
fetch('https://management-api.suprsend.com/v1/{workspace}/ws_key/', 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://management-api.suprsend.com/v1/{workspace}/ws_key/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"ServiceToken <token>: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://management-api.suprsend.com/v1/{workspace}/ws_key/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("ServiceToken <token>", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://management-api.suprsend.com/v1/{workspace}/ws_key/")
.header("ServiceToken <token>", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://management-api.suprsend.com/v1/{workspace}/ws_key/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["ServiceToken <token>"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"meta": {
"count": 2,
"limit": 10,
"offset": 0
},
"results": [
{
"id": "ws_key_01ABCDEFGHJKMNPQRSTVWXYZ0",
"name": "default",
"key": "SS.WSK.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"secret": "SS.WSS.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"is_default": true,
"is_active": true,
"is_deleted": false,
"allowed_domains": [],
"created_at": "2024-08-27T10:54:03.512045Z",
"created_by": null,
"rotated_at": null,
"rotated_by": null,
"deleted_at": null,
"deleted_by": null
},
{
"id": "ws_key_01ABCDEFGHJKMNPQRSTVWXYZ1",
"name": "ops-cli",
"key": "SS.WSK.YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY",
"secret": "SS.WSS.YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY",
"is_default": false,
"is_active": true,
"is_deleted": false,
"allowed_domains": [],
"created_at": "2026-09-28T11:12:23.557360Z",
"created_by": {
"name": "System User",
"email": "org_XXXXXXXXXXXXXXXXXXXXXX@systemuser.suprsend.com"
},
"rotated_at": null,
"rotated_by": null,
"deleted_at": null,
"deleted_by": null
}
]
}{
"code": 401,
"error_code": "authentication_failed",
"type": "AuthenticationFailed",
"message": "Invalid service token.",
"detail": "Invalid service token."
}{
"code": 404,
"error_code": "not_found",
"type": "NotFound",
"message": "workspace 'demo' not found",
"detail": "workspace 'demo' not found"
}