DEVELOPER API v2.6.4

Platform API

Connect your workspace data to the tools you build.

First request Get API access

REST JSON OpenAPI 3.1.0

endpoints: 167
resource groups: 19
data models: 118

Explore endpoints

Your first request

Public example

Base URL https://api.csfaas.comREST · application/json

GET/meExample endpoint

Who am I

Confirm your user, workspace and permissions.

Authenticate

Request

Read the result

Headers & response fields

Request headers

Authorizationstring required

Bearer YOUR_API_KEY
Use a key created in Settings → API & MCP.

X-Workspace-Iduuid optional

Target workspace (required for the browser JWT scheme; ignored for API keys, which are workspace-bound).

Response fields 200 · application/json

data.userobject

data.workspace_idstring

data.channelstring

data.permissionsobject

Response statuses

200

The resource. An unauthorized/absent resource is 404; an RLS-empty relation is null.

401

Missing or invalid credentials.

403

Workspace or member API approval is missing, workspace access is disabled, or membership is unavailable.

429

Rate limit exceeded (120 reads/min; 30 writes/min — separate buckets).

Your permissions apply

Your workspace roles apply to every request. Writes also need a credential with write access.

RequestcURL

curl --request GET 'https://api.csfaas.com/me' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

ResponseSelected fields · fictional data

{
  "data": {
    "user": {
      "id": "6a1f0f0e-1111-4a5a-9c3b-9f4b7f4a2b10",
      "email": "you@org.com"
    },
    "workspace_id": "ef0a094f-2222-4bd4-8a1e-33d2b1c0a001",
    "channel": "api_key"
  }
}

This documentation sample does not make an API request. API calls require an approved workspace and an included member.

Explore the API

167 endpoints

Risks, compliance, assets and more. A preview of 16 endpoints, including your first request.

GET/risksList risk assessmentsRisks
GET/demandsList risk demandsDemands
POST/remediationsCreate a remediation planRemediations
GET/controlsList implemented controls (current policy versions)Controls
GET/policiesList security policiesPolicies
GET/frameworksList frameworksFrameworks
GET/auditsList audits with countsAudits
GET/third-partiesList third partiesThird parties
PATCH/systems/{id}Update a systemSystems
GET/formsList forms (questionnaires)Forms
GET/promptsList the reusable AI prompt libraryPrompts
GET/evidencesSearch evidence metadata (11 domains)Evidences
GET/searchGlobal search across all entitiesSearch & statistics
GET/statistics/{module}The statistics hub (overview / risks / policies / frameworks / third-parties)Search & statistics
GET/catalog/{kind}Search the controls / threats databaseCatalogs

151 more endpoints in the full reference, with request details, examples and data models.

Sign in to the API reference

Use your CSFaaS account to check workspace access.