Change log for the ITONICS REST API

Updated December 08, 2025 15:25

This section is dedicated to tracking all modifications, enhancements, and deprecations related to the ITONICS Enterprise REST API. Its primary purpose is to provide a clear, chronological reference regarding breaking and noteworthy changes that could potentially affect existing automations or integrations.

We document all changes, clearly distinguishing between Breaking changes (which require client action) and Non-Breaking changes (which provide further information or context).

Please note: This feature needs to be activated by ITONICS. Please contact your Customer Success Manager or Account Manager for further assistance.

Table of contents

3.22.0 major release
3.21.0 major release
3.20.0 major release
3.19.0 major release

Structure

The change log is presented in reverse chronological order (latest changes at the top) and uses the following column structure to define the impact of each update:

Implication	Description
Category	The area of the API affected (e.g., data structure, endpoint, authentication, input format, meta control).
Change type / endpoint	Breaking: Requires immediate client action to prevent integration failure. Non-Breaking: An optional enhancement or internal change that does not break existing automations.
Description of change	A concise technical explanation of the modification made.
Client action required	Specific, clear instructions on what the client must do to maintain functionality or utilize the new feature.

Change log

3.22.0 major release

This section provides an overview of any breaking or noteworthy changes introduced to the ITONICS REST API with the 3.22.0 major release. Refer to the release notes for more detailed information on the release.

(1) NUC-17010 and NUC-17143

Implication	Description
Category	Endpoint updates, GET output format updates, property updates, introduction of further GET meta controls
Change type / endpoint	Breaking: Requires client action to prevent integration failure if utilizing the /api/roadmap/{id}.json GET endpoint in automations.
Description of change	Renamed properties: entity_id to element_id, (element) label to title, (element) content to abstract, and (milestone) label, content, and start date to milestone_title, milestone_description, and milestone_date Aligned milestone start- / end date format: now YYYY-MM-DD Added new auto-generated milestone ID milestone_generated_id as a reference Added new property is_synced to indicate if an element roadmap record is controlled by synchronized roadmap dates Introduced (custom) milestone fields configured from entity-specific milestone configuration Global milestone type information is still listed in utility_data Connection information must now be retrieved via /api/roadmap/{id}.json?type=connection Introduced page and limit meta controls for roadmap endpoints
Client action required	Ensure existing automations are updated to reflect the updated property labels and output formats of the /api/roadmap/{id}.json endpoint, and targeting the correct (sub-)endpoint, e.g. for retrieval of connection type information (/api/roadmap/{id}.json?type=connection), and page and limit parameters used to maintain performance

(2) NUC-16616 and NUC-16617

Implication	Description
Category	Added more information to existing endpoints and introduction of new endpoint
Change type / endpoint	Non-breaking: Additional information provided in /api/{entity_type}.json and /api/{entity_type}/{id}.json /api/user.json and /api/user/{id}.json GET endpoints and new /api/user_field_properties.json GET endpoint introduced.
Description of change	Added UIDs for creator, editor followers, etc. for facilitated reference in element GET endpoint response Introduced further information, a.o. user_roles, profile_image, and other default user fields for consistency in user GET endpoints Added custom user field information; introduced new /api/user_field_properties.json GET endpoint to retrieve (custom) user field configuration
Client action required	Existing automations must not be updated right away to reflect the changes. However, esp. with the introduction of the additional user field properties, a more thorough reporting on user data via the GET API can be tackled.

3.21.0 major release

This section provides an overview of any breaking or noteworthy changes introduced to the ITONICS REST API with the 3.21.0 major release. Refer to the release notes for more detailed information on the release.

(1) NUC-16338

Implication	Description
Category	GET output format update
Change type / endpoint	Breaking: Requires client action to prevent integration failure if utilizing /api/{entity_type}.json and /api/{entity_type}/{id}.json GET endpoints in automations.
Description of change	Aligned output format of hierarchy-/segment field options in the element GET endpoint responses with our standard format Before: “field_machine_name” { “segment_field_machine_name_entity_segment”: “string”} After: “field_machine_name” { “segment_field_machine_name_entity_segment”: {“field_option_id”: {“label”: “string”, “parent”: “parent_segment_option_id”}}
Client action required	Ensure existing automations are updated to reflect the adjusted output format for segment- / hierarchy fields in the /api/roadmap/{id}.json endpoint response

(2) NUC-16056

Implication	Description
Category	Added more information to existing endpoints
Change type / endpoint	Non-breaking: Additional information provided in /api/{entity_type}.json and /api/{entity_type}/{id}.json, as well as /api/itonics_idea.json and /api/itonics_idea/{id}.json GET endpoints.
Description of change	New properties for external submitter information: "field_ext_firstname": "string", "field_ext_lastname": "string", "field_ext_email": "email_string"
Client action required	Existing automations must not be updated right away to reflect the changes. However, a more thorough reporting on externally submitted element data via the GET API can be tackled.

(3) NUC-15075

Implication	Description
Category	Introduction of new endpoints, and added more information to existing endpoints
Change type / endpoint	Non-breaking: New GET endpoints (re-)introduced: /api/itonics_campaign_tr3.json and /api/itonics_campaign_tr3/{id}.json, /api/itonics_idea.json and /api/itonics_idea/{id}.json, as well as /api/entity_field_properties.json?type=itonics_campaign_tr3&entity_id{id}, respectively /api/entity_field_properties.json?type=itonics_idea&camp_id={id}
Description of change	(Re-) provided for basic campaign GET information via /api/itonics_campaign_tr3.json and /api/itonics_campaign_tr3/{id}.json endpoints Included visibility information (and also added element GET endpoints if an {entity_type} has visibility enabled) Introduced (default) submission fields configured per campaign element, provided via /api/{entity_type}.json and /api/{entity_type}/{id}.json endpoints The submission field configuration can be retrieved via /api/entity_field_properties.json?type=itonics_campaign_tr3&entity_id{id}, respectively /api/entity_field_properties.json?type=itonics_idea&camp_id={id}
Client action required	Existing automations must not be updated right away to reflect the changes. However, more thorough reporting on ideation use cases via the GET API can be tackled, as well as building on the POST/PUT endpoints introduced in 3.23.0.

3.20.0 major release

This section provides an overview of any breaking or noteworthy changes introduced to the ITONICS REST API with the 3.20.0 major release. Refer to the release notes for more detailed information on the release.

(1) NUC-15522

Implication	Description
Category	Introduction of new endpoints, and added more information to existing endpoints
Change type / endpoint	Non-breaking: New PUT/POST endpoints introduced for campaign submissions
Description of change	Introduced new endpoint to create campaign submissions via API, covering (default) submission fields: /api/itonics_idea.json Introduced new endpoint to update campaign submissions via API, covering (default) submission fields: /api/itonics_idea/{id}.json
Client action required	Existing automations must not be updated right away to reflect the changes. However, now API automations can be tackled to push external idea data into the ITONICS application.

3.19.0 major release

This section provides an overview of any breaking or noteworthy changes introduced to the ITONICS REST API with the 3.19.0 major release. Refer to the release notes for more detailed information on the release.

(1) NUC-14814

Implication	Description
Category	Endpoint updates, introduction of new endpoints
Change type / endpoint	Breaking: Requires client action to prevent integration failure if utilizing the /api/{entity_type}.json or /api/{entity_type}/{id}.json GET endpoints to retrieve timeline/history in automations.
Description of change	Removed the timeline data from the existing endpoints /api/{entity_type}/{id}.json and /api/{entity_type}.json Instead, introduced new, dedicated GET endpoints for timeline data /api/timeline.json?entity_type={entity_type} /api/timeline.json?entity_type={entity_type}&entity_id={entity_id} Also, introduced a new permission Access the resource timeline via API (global permission) to control timeline data access
Client action required	Ensure existing automations are updated to point to the correct new GET endpoint(s) to keep on retrieving timeline data.

Note: No significant changes worth communicating from lower release versions.