curl --request GET \
--url https://api.getmodus.com/api/v1/scopes \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.getmodus.com/api/v1/scopes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.getmodus.com/api/v1/scopes', 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://api.getmodus.com/api/v1/scopes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api.getmodus.com/api/v1/scopes"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getmodus.com/api/v1/scopes")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmodus.com/api/v1/scopes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"scopes": [
{
"id": 42,
"slug": "customer-churn-analyzer-a3f",
"name": "Customer Churn Analyzer",
"status": "active",
"orgUuid": "00000000-0000-0000-0000-000000000001",
"hasUnpublishedChanges": false,
"accessConfig": {
"visibility": "shared",
"groupPermissions": {
"group_eng_uuid": {
"use": true,
"manage": false
}
},
"guardrails": [],
"sharedWith": [],
"ownerUserId": "user_2abc",
"ownerEmail": "alice@example.com"
},
"createdAt": "2026-05-01T10:00:00.000Z",
"updatedAt": "2026-05-11T10:00:00.000Z",
"canManage": true,
"canUse": true,
"manageDenial": "needs_group_manage",
"description": "Predicts churn risk for a customer given a 90-day usage window.",
"activeVariationId": "00000000-0000-4000-a000-000000000100",
"draftVariationId": "00000000-0000-4000-a000-000000000101",
"pendingOwnershipTransfer": {
"pendingOwnerUserId": "user_2abc123def456",
"requestedByUserId": "user_2xyz789ghi012",
"requestedAt": "2026-06-05T12:00:00.000Z",
"pendingOwnerEmail": "newowner@example.com"
},
"variation": {
"expectedOutput": "A 3-bullet summary highlighting churn risk drivers.",
"instructions": [
"Be concise.",
"Always justify the score."
],
"model": "anthropic/claude-sonnet-4.6",
"toolset": {
"web_search": {
"enabled": true
},
"calculator": {
"enabled": true
}
},
"connectionSet": [
{}
],
"contextSelections": [
{}
],
"evaluations": [
{}
],
"interfaces": [
{}
],
"supervisionSubordinateIds": [
"12",
"17"
],
"supervisionSubordinateDescriptions": {
"12": "Reads warehouse facts",
"17": "Drafts the report"
},
"modelSettings": {
"contextWindow": 2
}
},
"deletedAt": null
}
],
"nextPageToken": "<string>"
}{
"error": {
"code": "BAD_REQUEST",
"status": "INVALID_ARGUMENT",
"message": "Invalid value for query parameter `pageSize`.",
"requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS"
}
}{
"error": {
"code": "UNAUTHORIZED",
"status": "UNAUTHENTICATED",
"message": "Missing or invalid access token.",
"requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS"
}
}{
"error": {
"code": "FORBIDDEN",
"status": "PERMISSION_DENIED",
"message": "Missing required scope(s) for this operation.",
"requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS",
"info": {
"missing": [
"<required-scope>"
]
}
}
}{
"error": {
"code": "INTERNAL_ERROR",
"status": "INTERNAL",
"message": "An unexpected error occurred.",
"requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS"
}
}List scopes
Returns a paginated page of scopes the caller can at least use. Scopes the caller cannot see are filtered out. Pagination uses an opaque token returned in nextPageToken.
Requires: scopes:read
curl --request GET \
--url https://api.getmodus.com/api/v1/scopes \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.getmodus.com/api/v1/scopes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.getmodus.com/api/v1/scopes', 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://api.getmodus.com/api/v1/scopes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api.getmodus.com/api/v1/scopes"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getmodus.com/api/v1/scopes")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmodus.com/api/v1/scopes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"scopes": [
{
"id": 42,
"slug": "customer-churn-analyzer-a3f",
"name": "Customer Churn Analyzer",
"status": "active",
"orgUuid": "00000000-0000-0000-0000-000000000001",
"hasUnpublishedChanges": false,
"accessConfig": {
"visibility": "shared",
"groupPermissions": {
"group_eng_uuid": {
"use": true,
"manage": false
}
},
"guardrails": [],
"sharedWith": [],
"ownerUserId": "user_2abc",
"ownerEmail": "alice@example.com"
},
"createdAt": "2026-05-01T10:00:00.000Z",
"updatedAt": "2026-05-11T10:00:00.000Z",
"canManage": true,
"canUse": true,
"manageDenial": "needs_group_manage",
"description": "Predicts churn risk for a customer given a 90-day usage window.",
"activeVariationId": "00000000-0000-4000-a000-000000000100",
"draftVariationId": "00000000-0000-4000-a000-000000000101",
"pendingOwnershipTransfer": {
"pendingOwnerUserId": "user_2abc123def456",
"requestedByUserId": "user_2xyz789ghi012",
"requestedAt": "2026-06-05T12:00:00.000Z",
"pendingOwnerEmail": "newowner@example.com"
},
"variation": {
"expectedOutput": "A 3-bullet summary highlighting churn risk drivers.",
"instructions": [
"Be concise.",
"Always justify the score."
],
"model": "anthropic/claude-sonnet-4.6",
"toolset": {
"web_search": {
"enabled": true
},
"calculator": {
"enabled": true
}
},
"connectionSet": [
{}
],
"contextSelections": [
{}
],
"evaluations": [
{}
],
"interfaces": [
{}
],
"supervisionSubordinateIds": [
"12",
"17"
],
"supervisionSubordinateDescriptions": {
"12": "Reads warehouse facts",
"17": "Drafts the report"
},
"modelSettings": {
"contextWindow": 2
}
},
"deletedAt": null
}
],
"nextPageToken": "<string>"
}{
"error": {
"code": "BAD_REQUEST",
"status": "INVALID_ARGUMENT",
"message": "Invalid value for query parameter `pageSize`.",
"requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS"
}
}{
"error": {
"code": "UNAUTHORIZED",
"status": "UNAUTHENTICATED",
"message": "Missing or invalid access token.",
"requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS"
}
}{
"error": {
"code": "FORBIDDEN",
"status": "PERMISSION_DENIED",
"message": "Missing required scope(s) for this operation.",
"requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS",
"info": {
"missing": [
"<required-scope>"
]
}
}
}{
"error": {
"code": "INTERNAL_ERROR",
"status": "INTERNAL",
"message": "An unexpected error occurred.",
"requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS"
}
}Authorizations
A Modus personal access token (modus_<orgUuid>_<prefix>_<secret>) or an OAuth 2.1 access token, sent as Authorization: Bearer <token>.
Query Parameters
Opaque page token from a previous response's nextPageToken. Omit for the first page.
Max items per page. Defaults to 25, clamped to 100.
1 <= x <= 10025
Variation view. active reads deployed; draft reads the latest builder snapshot.
active, draft Case-insensitive substring filter on scope name.
"churn"
Return only scopes supervised by this manager scope id.
17
Include the requested variation payload (toolset, connectionSet, supervisionSubordinateIds, etc.) on list rows.
false