Skip to main content
GET
/
api
/
public
/
v1
/
scopes
List available API scopes
curl --request GET \
  --url https://api.coldsend.pro/api/public/v1/scopes \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "message": "<string>",
  "scopes": [
    {
      "scope": "<string>",
      "description": "<string>",
      "category": "<string>"
    }
  ],
  "categories": {},
  "recommended_groups": [
    {
      "name": "<string>",
      "description": "<string>",
      "scopes": [
        "<string>"
      ]
    }
  ]
}

Authorizations

X-API-Key
string
header
required

API key with format cs_live_xxx

Query Parameters

Response

Scopes retrieved successfully

Response for listing all available scopes.

success
boolean
required
message
string
required
scopes
ScopeInfo · object[]
required

List of all available scopes

categories
Categories · object
required

Scopes grouped by category

Recommended scope groups for common use cases