List Content Editors in workspace
curl --request GET \
--url https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors \
--header 'API-KEY: <api-key>'import requests
url = "https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors"
headers = {"API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'API-KEY': '<api-key>'}};
fetch('https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors', 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.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-KEY: <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://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("API-KEY", "<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://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"inserted_at": "2024-04-12T15:23:45Z",
"ai_article": {
"id": 123,
"status": "completed"
},
"ai_search_guidelines": {
"status": "completed"
},
"auto_optimize": {
"status": "completed"
},
"content_score": {
"ai_search": 62,
"seo": 75,
"total": 75
},
"created_by": "[email protected]",
"device": "mobile",
"id": 123,
"location": "United States",
"main_keyword": "seo tools",
"outline": {
"status": "completed"
},
"permalinks": [
{
"hash": "abc123xyz",
"type": "edit",
"url": "https://app.surferseo.com/drafts/s/abc123xyz"
}
],
"secondary_keywords": [
"keyword research",
"ai visibility"
],
"seo_guidelines": {
"status": "completed"
},
"state": "completed",
"workspace_id": 123,
"updated_at": "2024-06-01T09:17:33Z",
"custom_template_id": 2,
"custom_voice_id": 123,
"error": {
"details": [
{}
],
"reason": "<string>",
"message": "<string>"
},
"import_content_url": "https://example.com/article",
"surfer_template": "blog_post",
"target_word_count": 2000,
"use_brand_knowledge": true
}
],
"meta": {
"page": 1,
"page_size": 25,
"total": 156,
"total_pages": 7,
"filters": {
"inserted_after": "2024-04-12T15:23:45Z",
"state": "completed"
},
"order": "desc",
"sort": "inserted_at"
}
}{
"error": {
"details": [
{
"field": "keywords",
"reason": "required"
}
],
"reason": "validation_error"
}
}{
"error": {
"details": [],
"reason": "unauthorized"
}
}{
"error": {
"details": [],
"reason": "permission_denied"
}
}{
"error": {
"details": [],
"reason": "not_found"
}
}{
"error": {
"details": [
{
"allowed": [
"application/json"
],
"field": "accept",
"reason": "unsupported"
}
],
"message": "Accept must be one of: application/json",
"reason": "not_acceptable"
}
}{
"error": {
"details": [
{
"retry_after": 30
}
],
"reason": "rate_limit_exceeded"
}
}Content Editors
List Content Editors in workspace
Returns a paginated list of Content Editors for the workspace.
Subject to a 90-day time-range filter limit.
Unknown filter keys are ignored. Applied filters are reflected in the response meta.filters object.
Rate limit: 10 requests/sec
GET
/
api
/
v2
/
workspaces
/
{workspace_id}
/
content_editors
List Content Editors in workspace
curl --request GET \
--url https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors \
--header 'API-KEY: <api-key>'import requests
url = "https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors"
headers = {"API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'API-KEY': '<api-key>'}};
fetch('https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors', 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.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-KEY: <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://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("API-KEY", "<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://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"inserted_at": "2024-04-12T15:23:45Z",
"ai_article": {
"id": 123,
"status": "completed"
},
"ai_search_guidelines": {
"status": "completed"
},
"auto_optimize": {
"status": "completed"
},
"content_score": {
"ai_search": 62,
"seo": 75,
"total": 75
},
"created_by": "[email protected]",
"device": "mobile",
"id": 123,
"location": "United States",
"main_keyword": "seo tools",
"outline": {
"status": "completed"
},
"permalinks": [
{
"hash": "abc123xyz",
"type": "edit",
"url": "https://app.surferseo.com/drafts/s/abc123xyz"
}
],
"secondary_keywords": [
"keyword research",
"ai visibility"
],
"seo_guidelines": {
"status": "completed"
},
"state": "completed",
"workspace_id": 123,
"updated_at": "2024-06-01T09:17:33Z",
"custom_template_id": 2,
"custom_voice_id": 123,
"error": {
"details": [
{}
],
"reason": "<string>",
"message": "<string>"
},
"import_content_url": "https://example.com/article",
"surfer_template": "blog_post",
"target_word_count": 2000,
"use_brand_knowledge": true
}
],
"meta": {
"page": 1,
"page_size": 25,
"total": 156,
"total_pages": 7,
"filters": {
"inserted_after": "2024-04-12T15:23:45Z",
"state": "completed"
},
"order": "desc",
"sort": "inserted_at"
}
}{
"error": {
"details": [
{
"field": "keywords",
"reason": "required"
}
],
"reason": "validation_error"
}
}{
"error": {
"details": [],
"reason": "unauthorized"
}
}{
"error": {
"details": [],
"reason": "permission_denied"
}
}{
"error": {
"details": [],
"reason": "not_found"
}
}{
"error": {
"details": [
{
"allowed": [
"application/json"
],
"field": "accept",
"reason": "unsupported"
}
],
"message": "Accept must be one of: application/json",
"reason": "not_acceptable"
}
}{
"error": {
"details": [
{
"retry_after": 30
}
],
"reason": "rate_limit_exceeded"
}
}Authorizations
Path Parameters
Required range:
x >= 1Example:
123
Query Parameters
Page number (1-indexed).
Required range:
x >= 1Number of items per page.
Required range:
1 <= x <= 100Field to sort by.
Available options:
inserted_at, updated_at Sort direction.
Available options:
asc, desc Filter by state.
Available options:
completed, executing, failed, scheduled Only return Content Editors created after this ISO8601 timestamp.
Only return Content Editors created before this ISO8601 timestamp.
Was this page helpful?