Assessment API

List Assessments

GET /v1/assessments

Returns a list of all assessments associated with your organization. Results are paginated and sorted by creation date (newest first).

Query Parameters

Response

{
  "data": [
    {
      "id": "asmt_abc123",
      "company": "Acme Corp",
      "status": "in_progress",
      "phase": "mapping",
      "progress": 65,
      "createdAt": "2025-01-10T08:00:00Z",
      "estimatedCompletion": "2025-02-21T08:00:00Z"
    }
  ],
  "meta": {
    "total": 3,
    "nextCursor": "cur_xyz789"
  }
}

Get Assessment

GET /v1/assessments/:id

Returns detailed information about a specific assessment, including current phase, progress metrics, and connected integrations.

Response

{
  "data": {
    "id": "asmt_abc123",
    "company": "Acme Corp",
    "status": "in_progress",
    "phase": "mapping",
    "progress": 65,
    "integrations": [
      { "tool": "slack", "status": "connected", "connectedAt": "2025-01-10T09:15:00Z" },
      { "tool": "jira", "status": "connected", "connectedAt": "2025-01-10T09:22:00Z" },
      { "tool": "github", "status": "connected", "connectedAt": "2025-01-10T09:30:00Z" }
    ],
    "metrics": {
      "workflowsMapped": 24,
      "bottlenecksIdentified": 8,
      "dataPointsCollected": 145200
    },
    "createdAt": "2025-01-10T08:00:00Z",
    "estimatedCompletion": "2025-02-21T08:00:00Z"
  }
}

Get Assessment Report

GET /v1/assessments/:id/report

Returns the full assessment report once the assessment status is completed. Returns a 404 if the assessment is still in progress.

The report includes executive summary, workflow maps, bottleneck analysis, AI opportunity rankings, and ROI projections. The response is a large JSON object — consider using the sections parameter to request specific sections.

Query Parameters

Error Codes

See also: Webhooks for real-time notifications, or Authentication for API key management.