Published a new Documentation guide that explains regional API hostnames, which products are supported on each regional edge (and which combinations are not), example requests, and compliance-oriented guidance for choosing the correct region. No API endpoints, schemas, or runtime behaviour have changed.
Changes
Documentation
Regional endpoints and compliance (new guide)
N/A → Published under Documentation
Type:addition
Notes: See the guide for hostnames per region, product availability by region, and operational compliance context. Helps integrators avoid calling the wrong edge for a tenant’s provisioned region.
Adds a new Frameworks objective surface area in ControlMap, including partner-level and client-level objective summaries, objective search, and objective detail retrieval.
Adds new client group, goal template, initiative template, asset lookup, and assessment question comment endpoints across Lifecycle Manager. This release also updates initiative endpoints to support rich-text executive summaries, changes meeting attendee endpoints to use wrapped request bodies and 201 Created on add operations, and extends deliverable endpoints with support for a new Custom component type plus optional section naming where applicable.
Notes: Assessment detail responses now include record_created_at on the assessment and comment_json plus record_created_at on assessment question comments.
Notes: The request body now uses an object wrapper with contact_keys instead of a raw array, and the success response changed from 200 OK to 201 Created.
Introduces new assessment-related endpoints across ControlMap, including client and partner assessment summaries, assessment question retrieval and search, answer management, mapping operations, and assessment responses. This release also deprecates several legacy GET list endpoints in favor of POST-based querying patterns and adds a new refresh_status field to evidence responses.
Changes
ControlMap
Assessment controller
Partner assessment summary endpoint added
Type:addition
Notes: Adds GET /controlmap/v1/clients/assessments/common/summary for partner-level assessment overview across clients.
Assessment controller
Client assessment summary endpoint added
Type:addition
Notes: Adds GET /controlmap/v1/clients/{client_id}/assessments/common/summary for client-specific assessment summary retrieval.
Assessment controller
Assessment question search endpoint added
Type:addition
Notes: Adds POST /controlmap/v1/clients/{client_id}/assessments/common/questions/search for filtered and paginated assessment question queries.
Assessment controller
Assessment question detail endpoint added
Type:addition
Notes: Adds GET /controlmap/v1/clients/{client_id}/assessments/common/questions/{question_code} for retrieving a single assessment question by code.
Assessment controller
Assessment answer management endpoints added
Type:addition
Notes: Adds PUT and DELETE /controlmap/v1/clients/{client_id}/assessments/common/questions/{question_code}/answer to save and clear answers for an assessment question.
Assessment controller
Assessment mapping endpoints added
Type:addition
Notes: Adds POST and DELETE /controlmap/v1/clients/{client_id}/assessments/common/questions/{question_code}/mappings to map and unmap assessment questions to evidences, action items, policies, and procedures.
Assessment controller
Assessment response endpoints added
Type:addition
Notes: Adds POST and PATCH /controlmap/v1/clients/{client_id}/assessments/common/questions/{question_code}/responses, plus DELETE /controlmap/v1/clients/{client_id}/assessments/common/questions/{question_code}/responses/{response_id}, for creating, updating, and deleting assessment question responses.
Evidence controller
refresh_status added to evidence response
Type:addition
Notes:EvidenceResponse now includes refresh_status, allowing clients to surface evidence freshness state.
Evidence controller
Legacy GET list endpoint deprecated
Type:deprecation
Notes:GET /controlmap/v1/clients/{client_id}/evidences is now deprecated. Consumers should move toward the POST search/query pattern where applicable.
Risk controller
Legacy GET list endpoint deprecated
Type:deprecation
Notes:GET /controlmap/v1/clients/{client_id}/risks is now deprecated in favor of the existing POST-based query pattern.
Action Item controller
Legacy GET list endpoint deprecated
Type:deprecation
Notes:GET /controlmap/v1/clients/{client_id}/action-items is now deprecated in favor of the existing POST-based query pattern.
Introduces several contract changes across Core controllers, including new POST-based query patterns, field removals from related objects, and nullability updates. Some of these changes are backwards incompatible and may require client updates.
Changes
Core
Client controller
type → lifecycle
Type:breaking
Notes: The type field has been renamed to lifecycle. Clients referencing type must update to the new field name.
Client controller
longitude, latitude non-nullable → nullable
Type:behavior-change
Notes: Location fields may now be omitted or returned as null.
Contact controller
GET query → POST-based querying
Type:breaking
Notes: Querying by email, phone, and name fields (first, middle, last, full) must now be provided in the POST request body.
Contract controller
Contact fields removed
Type:breaking
Notes:name and email have been removed from the embedded contact object.
Hardware Asset controller
Contact fields removed
Type:breaking
Notes:name and email have been removed from the embedded contact object.
Member controller
GET query → POST-based querying
Type:breaking
Notes: Querying by email, phone, and name fields (first, middle, last, full) must now be provided in the POST request body.
Member controller
reports_to_member fields removed
Type:breaking
Notes:name and email have been removed from reports_to_member.
Opportunity controller
Contact fields removed
Type:breaking
Notes:name and email have been removed from the embedded contact object.
Opportunity controller
responsible_member.name removed
Type:breaking
Notes: Consumers must rely on IDs or related lookups for responsible member details.
SaaS User controller
Contact fields removed
Type:breaking
Notes:name and email have been removed from the embedded contact object.
Ticket controller
owner_member.name removed
Type:breaking
Ticket controller
responsible_member.name removed
Type:breaking
Ticket controller
Contact fields removed
Type:breaking
Notes:name and email have been removed from the embedded contact object.
Ticket controller
status removed from contract
Type:breaking
Notes:status has been removed from the embedded contract object.
Ticket controller
board.id non-nullable → nullable
Type:behavior-change
Ticket controller
Timeline fields non-nullable → nullable
Type:behavior-change
Notes:timeline.created_at and timeline.updated_at may now be returned as null.
The Core API documentation now explicitly lists supported enum values across multiple endpoints and resources. This improves discoverability, reduces guesswork, and helps API consumers validate inputs and handle responses correctly.
Changes
Core
GET /core/v1/integrations/vendors
Strings → Explicit enums
Type:fix
Notes: The following fields now list supported values in the schema:
category:
PSA
RMM
SaaS
Network
Documentation
Backup
Customer Satisfaction
Cybersecurity
PSA & RMM
data_types_supported[]:
CLIENT
CONTRACT
CONTACT
HARDWARE_ASSET
MEMBER
OPPORTUNITY
SAAS_ASSET
SAAS_USER
TICKET
GET /core/v1/integrations/configurations
Array of strings → Enum values
Type:fix
Notes: The following field now lists supported values:
primary[]:
CLIENT
CONTRACT
CONTACT
HARDWARE_ASSET
MEMBER
OPPORTUNITY
SAAS_ASSET
SAAS_USER
TICKET
GET /core/v1/service/contracts
Strings → Explicit enums
Type:fix
Notes: Contract models now expose supported values for:
status:
SUSPENDED
EXPIRED
ACTIVE
DRAFT
SENT
SIGNED
NOT_EXECUTED
CANCELLED
type:
MANAGED_SERVICES
BLOCK
3RD_PARTY
UNASSIGNED
contract_pricings[].status:
ACTIVE
INACTIVE
CANCELLED
EXPIRED
contract_pricings[].pricing_type:
UNKNOWN
UNIT
ALLOCATION
contract_pricings[].unit_type:
TICKET
HOURS
PRODUCT
RECURRING
contract_pricings[].recurrent_charge_frequency:
NOT_CHARGED
ONE_TIME
ANNUAL
SEMI_ANNUAL
QUARTERLY
BI_MONTHLY
MONTHLY
BI_WEEKLY
contract_term.billing_period:
NOT_BILLED
ONE_TIME
ANNUAL
SEMI_ANNUAL
QUARTERLY
BI_MONTHLY
MONTHLY
BI_WEEKLY
WEEKLY
GET /core/v1/service/tickets
Strings → Explicit enums
Type:fix
Notes: Ticket models now expose supported values for:
category:
INCIDENT
NETWORK_INCIDENT
FIREWALL_INCIDENT
ROUTER_INCIDENT
WIFI_INCIDENT
CONNECTIVITY_INCIDENT
SERVER_INCIDENT
HARDWARE_INCIDENT
WORKSTATION_INCIDENT
SHARED_PERIPHERAL_INCIDENT
MOBILE_DEVICE_INCIDENT
STORAGE_INCIDENT
SOFTWARE_INCIDENT
CLIENT_SOFTWARE_INCIDENT
SERVER_SOFTWARE_INCIDENT
COMMUNICATION_SYSTEM_INCIDENT
PHONE_SYSTEM_INCIDENT
MESSAGING_SYSTEM_INCIDENT
VIDEO_CONFERENCING_INCIDENT
SERVICE_REQUEST
NETWORK_SERVICE_REQUEST
FIREWALL_SERVICE_REQUEST
ROUTER_SERVICE_REQUEST
WIFI_SERVICE_REQUEST
CONNECTIVITY_SERVICE_REQUEST
SERVER_SERVICE_REQUEST
HARDWARE_SERVICE_REQUEST
WORKSTATION_SERVICE_REQUEST
SHARED_PERIPHERAL_SERVICE_REQUEST
MOBILE_DEVICE_SERVICE_REQUEST
STORAGE_SERVICE_REQUEST
SOFTWARE_SERVICE_REQUEST
CLIENT_SOFTWARE_SERVICE_REQUEST
SERVER_SOFTWARE_SERVICE_REQUEST
COMMUNICATION_SYSTEM_SERVICE_REQUEST
PHONE_SYSTEM_SERVICE_REQUEST
MESSAGING_SYSTEM_SERVICE_REQUEST
VIDEO_CONFERENCING_SERVICE_REQUEST
SECURITY
SECURITY_AUDIT
SECURITY_INCIDENT
SECURITY_SERVICE_REQUEST
SECURITY_TRAINING
OTHER
TRAINING
MEETING
CONSULTING
PROJECT
MAINTENANCE
DOCUMENTATION
OTHER_SERVICE_REQUEST
MANAGEMENT
ALERT
SERVICE
BILLING
ACCOUNT
CHANGE
OTHER_INCIDENT
DEVICE
VENDOR
status.current and status history:
NEW
ASSIGNED
SCHEDULED
TRIAGE
IN_PROGRESS
WAITING_CLIENT
WAITING_VENDOR
CANCELLED
COMPLETED
CLOSED
REOPENED
ESCALATED
CLIENT_RESPONDED
UNASSIGNED
priority.current and priority history:
1
2
3
4
5
UNASSIGNED
GET /core/v1/assets/hardware
Strings → Explicit enums
Type:fix
Notes: Hardware Asset models now expose supported values for:
type:
WORKSTATION
IMAGING
SERVER
NETWORK
MOBILE
VIRTUAL
software.antivirus.status:
UNKNOWN
DISABLED
RUNNING
software.antivirus.definition_status:
OUTOFDATE
UNKNOWN
UPTODATE
GET /core/v1/assets/saas
Strings → Explicit enums
Type:fix
Notes: SaaS Asset models now expose supported values for:
