ITONICS REST API: GET endpoints
What is it?
This article lists all endpoints available for reading data from your ITONICS application via GET requests - from elements and campaigns to ratings, roadmaps, table data, users and statistics - together with the permissions required to call each one.
This article is part of the ITONICS REST API series. For the overview, refer to Overview and getting started. For authentication, refer to Authentication and authorization.
Check out our public Postman API collection:
This dedicated resource provides detailed sample request bodies and complete output formats for all GET, POST, and PUT endpoints, ensuring you quickly understand the necessary technical specifications and expected JSON formats.
In this article
- Element retrieval
- Campaign and submission data retrieval
- Timeline data
- Rating data
- Followers and likes data
- System logs
- Roadmap data and roadmap logs
- Table data
- Metadata and structure
- User and role data and statistics
- System statistics
- API usage statistics
GET endpoints (Read)
The following tables list the endpoints available for reading (retrieving) data from your ITONICS application via GET requests. Common meta controls for pagination, sorting and filtering are described in GET meta controls and filter options. The expected response structures are described in GET response formats.
Note: The required permissions listed below describe the default (legacy) authorization mode. If the RBAC-enforced API mode is activated for your system, the respective application-level permissions are additionally required. Refer to API authorization modes in Authentication and authorization.
Element retrieval
| Endpoint | Details | Sample request |
|---|---|---|
/api/{entity_type}.json |
Returns a list of all elements for the specified type {entity_type} (e.g., itonics_trend). Includes all defined attributes for this {entity_type}, files (base64 encoded if configured), and relations (and if enabled, available visibility and external submitter information). Note: The response includes a rating_info object with the rating summary per criterion (criteria name, average rating as decimal and string, count of rating users, rating group), and the summary counts of followers and likes. The individual rating records are retrieved via the dedicated /api/entity_rating_info.json endpoint, and the detailed follower and liker user lists via /api/followers_likes.json. |
/api/itonics_trend.json |
/api/{entity_type}/{id}.json |
Returns a single element of type {entity_type} matching the URI {id}. Includes all defined attributes for this {entity_type}, files (base64 encoded if configured), and relations (incl. parent child relations if available), and if enabled/available visibility and external submitter information. Note: The response includes a rating_info object with the rating summary per criterion (criteria name, average rating as decimal and string, count of rating users, rating group), and the summary counts of followers and likes. The individual rating records are retrieved via the dedicated /api/entity_rating_info.json endpoint, and the detailed follower and liker user lists via /api/followers_likes.json. |
/api/itonics_trend/42.json |
Required permissions:
- "View {entity_type}" permission (entity-level)
- "Access the resource {entity_type} via API" permission (entity-level)
- + "View all (unpublished) {entity_type}" permission (entity-level) → returns all (draft/review) elements of the respective entity type (or one element matching the {id})
- + "View own (unpublished) {entity_type}" permission (entity-level) → returns own (draft/review) elements created by the particular user of the respective entity type (or one element matching the {id})
Campaign and submission data retrieval
| Endpoint | Details | Sample request |
|---|---|---|
/api/itonics_campaign_tr3.json |
Returns a list of all campaign elements (type itonics_campaign_tr3). Includes all defined attributes for this type, files (base64 encoded if configured), and relations. | /api/itonics_campaign_tr3.json |
/api/itonics_campaign_tr3/{id}.json |
Returns a single campaign element (type itonics_campaign_tr3) matching the URI {id}. Includes all defined attributes for this type, files (base64 encoded if configured), and relations. Further, campaign-specific (matching the URI {id}) phase information, number of submissions per phase, and visibility information. | /api/itonics_campaign_tr3/5.json |
Required permissions (campaign endpoints):
- "Access the resource itonics_campaign_tr3 via API" permission (must be set by ITONICS)
- "Access resource field properties for campaign" permission (entity-level)
- User must be included in the campaign(s) visibility tab information (campaign-level)
- + "View all (unpublished) campaigns" permission (entity-level) → returns all (draft/review) campaign elements (or one matching the {id})
- + "View own (unpublished) campaigns" permission (entity-level) → returns own (draft/review) campaign elements created by the particular user (or one matching the {id})
| Endpoint | Details | Sample request |
|---|---|---|
/api/itonics_idea.json |
Returns a list of all Idea elements (type itonics_idea). Includes all default attributes, campaign-specific custom submission field information, (active) phase information, author & evaluator assignments, rating information (past/active phases, 5-star), and external submitter information (if available) for each idea element associated with its campaign. | /api/itonics_idea.json |
/api/itonics_idea/{id}.json |
Returns a single Idea element (type itonics_idea) matching the URI {id}. Includes all default attributes, campaign-specific custom submission field information, (active) phase information, author & evaluator assignments, rating information (past/active phases, 5-star), and external submitter information (if available) matching the URI {id}. | /api/itonics_idea/10.json |
/api/itonics_idea.json?camp_id={id} |
Returns a list of all Idea elements (type itonics_idea) tied to a particular campaign ID {camp_id}. Includes all default attributes, campaign-specific custom submission field information, (active) phase information, author & evaluator assignments, rating information (past/active phases, 5-star), and external submitter information (if available) for each idea element associated with the specific campaign. | /api/itonics_idea.json?camp_id=20 |
Required permissions (idea endpoints):
- "Access the resource itonics_idea via API" permission (must be set by ITONICS)
- "View all/own campaigns" permission (entity-level)
- User must be included in the campaign(s) visibility tab information (campaign-level)
- + "View all ideas" permission (campaign-phase-level) → returns submission data for all submissions in the particular campaign phase or of one submission element matching the {id}
- + "View own ideas" permission (campaign-phase-level) → returns submission data created by the particular user in the specific campaign phase or of one submission element matching the {id}
- To access submission rating data: "Access rating analysis tab" permission (campaign-phase-level)
Timeline data
| Endpoint | Details | Sample request |
|---|---|---|
/api/timeline.json?entity_type={entity_type} |
Returns all available element timeline information for the specified {entity_type}. Likely requires setting limits, i.e. pagination, for large data sets. | /api/timeline.json?entity_type=itonics_trend&page=2 |
/api/timeline.json?entity_type={entity_type}&entity_id={entity_id} |
Returns all timeline information for a single element of type {entity_type} matching the specified {entity_id}. | /api/timeline.json?entity_type=itonics_trend&entity_id=5 |
Required permissions:
- "Access timeline via API" permission (global permission)
- "View element-level timeline page" permission (global permission)
- "Access the resource [entity_type] via API" permission (entity-level)
Rating data
| Endpoint | Details | Sample request |
|---|---|---|
/api/entity_rating_info.json?entity_type={entity_type} |
Returns the rating data for all elements of the specified {entity_type}: the rating summary per criterion (criteria name, average rating as decimal and string, count of rating users, rating group) and the individual rating records (user, rating value, rating date, comment, and rating status). Results are returned in a stable order by record ID (oldest first), so that paging through a large result set returns each record exactly once. Use the rating_from_date and rating_to_date filter controls to narrow the result set to a period. Likely requires setting limits, i.e. pagination, for large data sets. Note: This endpoint returns rating records and supports the rating_from_date, rating_to_date, and rating_status filters and page/limit pagination. Rating average range filtering and sorting by rating value are available on the element endpoints - refer to Rating filters and sorting. |
/api/entity_rating_info.json?entity_type=itonics_trend |
/api/entity_rating_info.json?entity_type={entity_type}&entity_id={id} |
Returns the rating data (refer to prior endpoint) for a single element of type {entity_type} matching the specified {entity_id}. | /api/entity_rating_info.json?entity_type=itonics_trend&entity_id=5 |
Required permissions:
- "Access the resource rating of {entity_type} via API" permission (entity-level)
- "View average ratings {entity_type}" permission (entity-level)
Followers and likes data
| Endpoint | Details | Sample request |
|---|---|---|
/api/followers_likes.json?entity_type={entity_type} |
Returns the detailed follower and like information for all elements of the specified {entity_type}, listing the users following and having liked each element (incl. user ID, full name, and username). Likely requires setting limits, i.e. pagination, for large data sets. Note: This endpoint returns the detailed follower and liker user lists. To rank elements by engagement, sort on the element endpoints using the number_of_likes or number_of_followers values - refer to Standard pagination and ordering controls. |
/api/followers_likes.json?entity_type=itonics_trend |
/api/followers_likes.json?entity_type={entity_type}&entity_id={id} |
Returns the detailed follower and like information (refer to prior endpoint) for a single element of type {entity_type} matching the specified {entity_id}. | /api/followers_likes.json?entity_type=itonics_trend&entity_id=5 |
Required permissions:
- "Access the resource followers_likes via API" permission (global permission)
- Standard access to the respective {entity_type} (e.g., "View {entity_type}" and "Access the resource {entity_type} via API" permission)
System logs
Note (applies to all four endpoints): filter controls, limits, and pagination work as expected, and the from_date and to_date filter controls also support YYYY-MM-DD hh:mm:ss format.
| Endpoint | Details | Sample request |
|---|---|---|
/api/system_logs/role-permission-configuration.json |
Returns all system logs for changes to the role permission configuration, including permission assignments and removals for different core modules. | /api/system_logs/role-permission-configuration.json |
/api/system_logs/role-configuration.json |
Returns all role configuration changes tracked in the system logs, including creation, update, and deletion of roles. | /api/system_logs/role-configuration.json |
/api/system_logs/user-role-configuration.json |
Returns all user role configuration changes tracked in the system logs, including previous and current role assignments, acting user, and targeted user. | /api/system_logs/user-role-configuration.json?to_date=2025-12-31 |
/api/system_logs/share-permission-log.json |
Returns all share permission changes for the grant/request permission feature tracked in the system logs, including approver, recipients, permissions granted/removed, and element and entity type affected. Note for this endpoint: date filter controls, entity_type filter limits, and pagination work as expected. |
/api/system_logs/share-permission-log.json?from_date=2026-04-01&entity_type=itonics_trend |
Required permissions:
/api/system_logs/role-permission-configuration.json: "Access system logs role permission via API" permission (global permission)/api/system_logs/role-configuration.json: "Access system logs role config via API" permission (global permission)/api/system_logs/user-role-configuration.json: "Access system logs user role via API" permission (global permission)/api/system_logs/share-permission-log.json: "Access system logs share permission via API" permission (global permission)
Roadmap data
| Endpoint | Details | Sample request |
|---|---|---|
/api/roadmap.json |
Returns a list of all existing roadmaps in the system. | /api/roadmap.json |
/api/roadmap/{id}.json |
Returns all roadmap details (layer information, element information, sync roadmap-/ date information, milestone date/type/custom field information, and roadmap manager information) matching the URI {id}. Use ?type=connection to retrieve roadmap connection types for the URI {id}.Note: you can make use of additional page and limit GET meta controls. |
/api/roadmap/8.json/api/roadmap/8.json?type=connection |
/api/roadmap_field_properties/{id}.json |
Returns the roadmap configuration required for constructing PUT requests for the roadmap matching the URI {id}: the layer hierarchy with valid layer IDs, the connection types enabled for the roadmap (both roadmap-specific and globally synced connection types, incl. title, color, and line style), and the configuration of the Roadmap Manager field (user search field). | /api/roadmap_field_properties/8.json |
Required permissions:
/api/roadmap.json: "View roadmap" module permission (must be set by ITONICS), "Access the resource roadmap" permission (must be set by ITONICS), "View roadmap visualization" permission (global permission), + "View all roadmaps" permission (global permission) → returns full roadmap list, + "View own roadmaps" permission (global permission) → returns roadmaps created by the particular user/api/roadmap/{id}.json: "View roadmap" module permission (must be set by ITONICS), "Access the resource roadmap" permission (must be set by ITONICS), "View roadmap visualization" permission (global permission), + "View all roadmaps" permission (global permission) → access all roadmaps, + "View own roadmaps" permission (global permission) → access own roadmaps created by the particular user/api/roadmap_field_properties/{id}.json: "Access the resource roadmap_field_properties" permission (granted to the Application Owner role by default)
Roadmap logs
| Endpoint | Details | Sample request |
|---|---|---|
/api/roadmap_logs/roadmap-configuration.json |
Returns the roadmap configuration change log: every create, edit, delete, archive, and restore action on a roadmap, with one record per save event rather than per changed field. Each record carries the roadmap, the action, the acting user, the timestamp, and the field-level changes for that save. Results are returned newest first. Note: filter controls, limits, and pagination work as expected, and the from_date and to_date filter controls also support YYYY-MM-DD hh:mm:ss format. Additional filter controls specific to this endpoint: action to filter by action type, and roadmap_id to return the log of a single roadmap - a roadmap_id that does not exist returns a 404 Not Found. A page or limit value that is not a positive integer returns a 412 Precondition Failed. Note: Events are logged from the activation of the feature onward; earlier roadmap changes are not back-filled. The endpoint is available where the Roadmap module is enabled. |
/api/roadmap_logs/roadmap-configuration.json?from_date=2026-10-01&roadmap_id=8 |
Required permissions:
- "Access roadmap configuration log via api" permission (global permission)
Table data
| Endpoint | Details | Sample request |
|---|---|---|
/api/table_data.json?entity_type={entity_type} |
Returns all available table data for the specified {entity_type}. Likely requires setting limits, i.e. pagination, for large data sets. | /api/table_data.json?entity_type=itonics_technology_tr3 |
/api/table_data.json?entity_type={entity_type}&entity_id={id} |
Returns all table data for a single element of type {entity_type} matching the specified {entity_id}. | /api/table_data.json?entity_type=itonics_technology_tr3&entity_id=10 |
Required permissions:
- "Access table structures via API" permission (global permission)
- "View table structures for {entity_type}" permission (entity-level)
Metadata and structure
| Endpoint | Details | Sample request |
|---|---|---|
/api/entity_field_properties.json?type={entity_type} |
Returns all attributes and their machine names, incl. mandatory options, validations, and selection options for the specified {entity_type}. | /api/entity_field_properties.json?type=itonics_trend |
/api/entity_field_properties.json?type=itonics_campaign_tr3 |
Returns all attributes and their machine names, incl. mandatory options, validations, and selection options for the campaign entity (type itonics_campaign_tr3). | /api/entity_field_properties.json?type=itonics_campaign_tr3 |
/api/entity_field_properties.json?type=itonics_campaign_tr3&entity_id={id} |
Returns all attributes and their machine names for the campaign entity (type itonics_campaign_tr3), and further the campaign-specific phase configuration, rating criteria per phase, and custom submission field information (incl. mandatory options, validations, and selection options) matching the URI {id}. | /api/entity_field_properties.json?type=itonics_campaign_tr3&entity_id=5 |
/api/entity_field_properties.json?type=itonics_idea&camp_id={id}/api/entity_field_properties.json?type=itonics_idea&entity_id={id} |
Returns all attributes and their machine names, and custom submission fields for the type itonics_idea of one particular campaign element matching the URI camp_id={id}. This endpoint must be queried before sending a POST request to create a new submission element for a campaign to understand the field structure. Alternatively, this endpoint can also be queried using the entity_id={id} of an existing submission element of type itonics_idea to get the same information on field structure. Field configuration properties: Each field entry returns its label, type, required flag, and the configured phase_visibility and field_visibility. Depending on the field type, further configuration properties are returned. is_multiple indicates whether a single line input field (custom_textfield), list field (dynamic_field), or user search field (custom_autosuggest) accepts several values, and is always false for the radio button renderer. options returns the configured list options of a list field, keyed by option ID and mapping to the option label (e.g. {"909": "Strategic", "910": "Operational"}); option IDs are stable across requests and are retained when other options are added or removed. isNumber, isEmail, and isUrl indicate the configured field validator of a single line input field - at most one is present per field, and none where no validator is configured. is_hybrid, limit_number (integer), and description are returned for user search fields, reflecting the hybrid setting, the maximum number of users accepted, and the configured help text. Note: The radio button and dropdown renderers share the type dynamic_field and are distinguished by is_multiple. Date picker fields return no options, is_multiple, or validator properties. |
/api/entity_field_properties.json?type=itonics_idea&camp_id=10/api/entity_field_properties.json?type=itonics_idea&entity_id=44 |
Required permissions (the four endpoints above):
- "Access the field properties via API" permission (global permission)
| Endpoint | Details | Sample request |
|---|---|---|
/api/entity_field_properties.json?type={entity_type}&config=milestone |
Returns all attributes and their machine names, incl. mandatory options, validations, and selection options for the milestone configuration of the specified {entity_type}. Further, this endpoint is restricted to entity types with the Roadmap module enabled. It provides global milestone type information via the utility_data property and lists all entities that currently have the Roadmap module activated. |
/api/entity_field_properties.json?type=itonics_technology_tr3&config=milestone |
Required permissions:
- "Access field properties via API" permission (global permission)
- "View all/own {entity_type}" permission (entity-level)
| Endpoint | Details | Sample request |
|---|---|---|
/api/user_field_properties.json |
Returns all attributes and their machine names, and custom user fields configured from the User Field Configuration. | /api/user_field_properties.json |
Required permissions:
- "Access user field properties via API" permission (global permission)
| Endpoint | Details | Sample request |
|---|---|---|
/api/entity_field_properties.json?type={entity_type}&config=table_data |
Returns all attributes and their machine names, incl. mandatory options, validations, and selection options for the table configuration of the specified {entity_type}. Each table structure additionally returns a locked property, true where the Lock table for editing setting is enabled in the table configuration and false where it is not. The property reflects a configuration change immediately. Note: the lock restricts adding, editing, and deleting rows through the interface only - refer to the PUT endpoint for API write behaviour (POST and PUT requests). |
/api/entity_field_properties.json?type=itonics_technology_tr3&config=table_data |
Required permissions:
- "Access user field properties via API" permission (global permission)
User and role data and statistics
| Endpoint | Details | Sample request |
|---|---|---|
/api/user.json |
Returns a list of all users, including meta information, like user ID, username, email, login/access information, role information, basic user attributes, and custom user properties. Use ?limit=x for large datasets to prevent running into timeout errors.Note: The response payload can be narrowed via the fields_included and fields_excluded meta controls, for example to retrieve identity information only, or to omit the base64-encoded profile image (refer to Field selection). |
/api/user.json?limit=25 |
/api/user/{id}.json |
Returns all meta information (refer to prior endpoint) for a specific user matching the URI {id}. | /api/user/212.json |
Required permissions:
- "Access the resource user" permission (must be set by ITONICS)
| Endpoint | Details | Sample request |
|---|---|---|
/api/user_stats/user_roles.json |
Returns a list of the configured user roles (and their role_id), total number of assigned users, and the percentage of user distribution across these roles. Note: The default system roles anonymous user, authenticated user, administrator, and Service Account are not included in the response. The distribution percentages are calculated across the returned roles only. |
/api/user_stats/user_roles.json |
/api/user_stats/login_rate.json |
Returns aggregated number of (unique) logins for a given date range (default: last 365 days). | /api/user_stats/login_rate.json |
/api/user_stats/active_users.json |
Returns various metrics, providing current totals and percentage comparison against the previous 30-day period. | /api/user_stats/active_users.json |
/api/user_stats/total_users.json |
Returns the overall total user count (total) plus metrics comparing the last 30 days to the preceding period. | /api/user_stats/total_users.json |
/api/user_stats/total_number_user.json |
Returns the total count of registered users as a numerical value. | /api/user_stats/total_number_user.json |
/api/user_stats/contributing_users.json |
Returns count of all users having rated, commented, created, or edited an element at least once. | /api/user_stats/contributing_users.json |
/api/user_stats.json?type=auth_log_success |
Returns the successful user logins (raw authentication events, non-aggregated). Note: Tracked for up to 365 days (intentional to avoid excessive data volume while ensuring reporting on the last 365d period). |
/api/user_stats.json?type=auth_log_success&sort=login_date&direction=desc&from_date=2026-03-24&to_date=2026-03-24&limit=1 |
/api/user_stats.json?type=auth_log_failed |
Returns the failed user login attempts (raw authentication events, non-aggregated). Note: Tracked only from the time the new endpoint has been introduced; thus, historical failed attempts prior to deployment of the 3.24.0 version are not available. |
/api/user_stats.json?type=auth_log_failed&from_date=2025-01-02&to_date=2026-03-01 |
Required permissions:
- "Access user statistic via API" permission (global permission)
System statistics
| Endpoint | Details | Sample request |
|---|---|---|
/api/entity_stats/entity_info.json |
Returns a list of all entity types, incl. their machine names, total element count, and element creation tendency (last 60 days). | /api/entity_stats/entity_info.json |
/api/entity_stats/general_statistics.json |
Returns aggregated element creation counts for a given date range (default: last 365 days) for every entity type. | /api/entity_stats/general_statistics.json |
/api/entity_stats/entity_status.json |
Returns the total number of all elements in the status draft, review, published, and archive. | /api/entity_stats/entity_status.json |
/api/entity_stats/activity_rate.json |
Returns aggregated activity counts (Rate, Like, Follow, Comment, Relate) for a given date range (default: last 365 days). | /api/entity_stats/activity_rate.json |
Required permissions:
- "Access entity statistic via API" permission (global permission)
API usage statistics
| Endpoint | Details | Sample request |
|---|---|---|
/api/api_stats.json |
Returns the aggregated number of API requests for a given date range (default: last 365 days). | /api/api_stats.json |
/api/api_stats/api_count.json |
Returns the total number of API requests and the count for the current month. | /api/api_stats/api_count.json |
Required permissions:
- "Access API statistic" permission (global permission)