Axio360 API Reference

Assessment Capabilities

This document describes the Axio360 API capabilities related to assessments. Each section explains what an API call does, what information it provides, and when you might use it. To authenticate API requests, see How to find your Axio360 API key.

1. Browsing & Retrieving Assessments

List All Assessments

Use this when you want a high-level view of everything in your account before diving into any single assessment.

Endpoint	`GET /api/v1/assessments`
What it does	Retrieves a complete list of all assessments your account has access to, along with basic identifying information for each one.
What it returns	Assessment ID Assessment name Description Associated model (framework) UUID Tags — the labels applied to the assessment (empty if none are set)
Common use cases	Seeing all assessments in your account at a glance Finding an assessment ID to use in a follow-up call Building a master list or index for reporting

Get Full Assessment Details

Use this when you need the complete picture of a specific assessment — every practice, every response, every action item, and every note.

Endpoint	`GET /api/v1/assessments/{id}`
What it does	Returns everything recorded within a single assessment: all practice-level responses, action items, and notes.
What it returns	Assessment name, description, and tags All practice responses — the current answer for each control (e.g., "Largely Implemented") Target response level per practice — the level the user has set as their goal; returns an explicit "no target set" indicator if none has been set Target date per practice — the date by which the user expects to reach that target (null if not set) Action items per practice, including: Action item text and due date Completion flag (`isDone`) and computed status — Done, Not Done, or Overdue Assignee — user ID and display name (null if unassigned) Criticality — IMPORTANT or ADDITIONAL Whether the action item is linked to the practice's target score Notes per practice
Common use cases	Pulling a full assessment snapshot for an audit or review Feeding assessment data into an external reporting tool or BI dashboard Comparing current vs. target responses to identify and prioritize gaps Exporting action items with owner and status for tracking in a spreadsheet or ticketing system

Get Assessment Scores

Use this when you want a scoring summary without needing the full detail of every individual response.

Endpoint	`GET /api/v1/assessments/{id}/scores`
What it does	Returns a scoring summary for a single assessment, broken down at multiple levels of granularity.
What it returns	Percent complete — how much of the assessment has been answered Overall assessment score (current, target, and maximum possible) Scores by domain (major category, e.g., Govern, Identify, Protect) Scores by objective (sub-category within each domain)
Common use cases	Displaying a score summary on an executive dashboard Tracking score changes over time by calling this periodically Comparing current vs. target scores to identify gaps at the domain or objective level

2. Assessment Models (Frameworks)

List All Assessment Models

Assessment models are the frameworks that assessments are built on — such as NIST CSF, C2M2, or CIS Controls. Use this call when you need to know which frameworks are available in your account.

Endpoint	`GET /api/v1/assessment-models`
What it does	Returns a list of all assessment models (frameworks) available to your account.
What it returns	Model UUID (required when creating a new assessment) Model title / framework name
Common use cases	Finding the UUID of a specific framework before creating a new assessment Inventorying which frameworks your account has licensed

Get Assessment Model Details

Use this when you need to understand the full structure of a framework — every practice (control question) and the possible answer options for each.

Endpoint	`GET /api/v1/assessment-models/{uuid}`
What it does	Returns the complete structure of a single assessment model, including every practice and the answer dimensions (scoring scales) available for each.
What it returns	All practices (controls/questions) within the model Answer dimensions and the available levels for each (e.g., Not Implemented → Fully Implemented) Full qualified names (FQNs) used to reference practices in other calls
Common use cases	Building a custom form or interface that mirrors the assessment structure Understanding all answer options before programmatically updating responses Mapping your internal control library to Axio360 practice identifiers

3. Creating & Updating Assessments

Create a New Assessment

Use this to programmatically spin up a new assessment — for example, as part of an onboarding workflow or automated provisioning process.

Endpoint	`POST /api/v1/assessments`
What it does	Creates a new assessment based on a specified model (framework). You can optionally pre-populate practice responses at the time of creation.
What it returns	The newly created assessment's ID and details Confirmation of any initial practice responses that were provided
Common use cases	Automating assessment setup for new business units or clients Importing assessment data from another system into Axio360 Programmatically seeding a new assessment with baseline responses

Update an Existing Assessment

Use this to modify an assessment that already exists — changing its name, description, or updating responses to specific practices.

Endpoint	`PATCH /api/v1/assessments/{id}`
What it does	Updates one or more fields of an existing assessment. Only the fields you include will be changed; everything else remains as-is.
What it returns	Confirmation of the updated assessment state Reflects changes to name, description, and/or practice responses
Common use cases	Pushing updated practice responses from an external tool back into Axio360 Renaming or re-describing an assessment to match an organizational change Syncing assessment data from a ticketing system or GRC platform

4. Tags

Get Tags for an Assessment

Use this to retrieve the tags associated with a specific assessment, or to filter assessments by tag name across your account.

Endpoint	`GET /api/v1/assessments/{id}/tags`
What it does	Returns all tags associated with a given assessment. Users with Read access or higher can call this endpoint. Supports filtering across assessments by tag name. If an assessment has no tags, the API returns an empty value.
What it returns	All tag labels applied to the assessment Empty value if no tags have been set
Common use cases	Programmatically grouping or filtering assessments by tag without manual intervention in the UI Building tag-based reporting across assessments (e.g., all assessments tagged "Tier 1") Checking which tags are applied to an assessment before updating or reporting on it

5. Action Items

Get All Action Items Across Assessments

Use this to retrieve a consolidated view of all action items across every assessment — without having to pull each assessment individually.

Endpoint	`GET /api/v1/action-items`
What it does	Returns all action items across all assessments accessible to the authenticated user in a single call. By default, only open (Not Done) items are returned. Use an explicit status filter to retrieve other items — for example, `?status=notdone` or `?status=all`.
What it returns	Assessment name Practice ID — the control the action item is tied to Action item name / description Assignee — user ID and display name (null if unassigned) Due date Computed status — Done, Not Done, or Overdue
Common use cases	Feeding open action items into a ticketing system (e.g., Azure DevOps, Jira) automatically Building a consolidated remediation dashboard across all assessments Closing out tickets in an external system when an action item is marked Done in Axio360
Native integrations	Axio360 includes native integrations with ServiceNow, Jira, Zendesk, and Bitsight. See how to configure these integrations in your account.

6. Milestones

Get Assessment Milestones

Use this to retrieve the historical score snapshots recorded for an assessment over time.

Endpoint	`GET /api/v1/assessments/{id}/milestones`
What it does	Returns all milestones recorded for a given assessment in a single call, including the score snapshot captured at the time each milestone was set.
What it returns	Milestone name and date Score snapshot at the time the milestone was created Current score, target score, and maximum possible score — enabling direct before/after comparison
Common use cases	Charting score improvement over time in a BI tool or executive dashboard Demonstrating progress to auditors or leadership by comparing milestone snapshots Benchmarking historical vs. current performance at the assessment level

Quick Reference

Method	Endpoint	Purpose
`GET`	`/api/v1/assessments`	List all assessments in the account
`GET`	`/api/v1/assessments/{id}`	Get full details of a single assessment
`GET`	`/api/v1/assessments/{id}/scores`	Get scoring summary for an assessment
`GET`	`/api/v1/assessment-models`	List all available frameworks
`GET`	`/api/v1/assessment-models/{uuid}`	Get full structure of a framework
`POST`	`/api/v1/assessments`	Create a new assessment
`PATCH`	`/api/v1/assessments/{id}`	Update an existing assessment
`GET`	`/api/v1/assessments/{id}/tags`	Get tags for a specific assessment
`GET`	`/api/v1/action-items`	Get all action items across assessments
`GET`	`/api/v1/assessments/{id}/milestones`	Get score milestones over time