--- title: "List timeline events" method: POST path: "/tasks/v1/timeline" tags: ["Issues", "Actions"] --- # List timeline events `POST /tasks/v1/timeline` ## Request body - S12TasksV1GetTimelineRequest - `task_id` string, required — Required. The UUID of the task whose timeline will be retrieved. ## Response `200` A successful response. - S12TasksV1GetTimelineResponse - `timeline_items` S12TasksV1TimelineItem[] — A list of items in the task timeline. - `item_id` string — The UUID of the timeline item - `task_id` string — The UUID of the task this timeline is associated with. - `creator` S12TasksV1TaskUser — The user associated to the task. They could be a creator or assignee. - `user_id` string — The UUID of this user. - `firstname` string — The first name of the user. - `lastname` string — The last name of the user. - `timestamp` string, date-time — UTC Timestamp for the timeline item. - `item_type` 'TIMELINE_ITEM_UNKNOWN' | 'TASK_CREATED' | 'TASK_TITLE_UPDATED' | 'TASK_DESCRIPTION_UPDATED' | 'TASK_ASSIGNEE_ADDED' | 'TASK_ASSIGNEE_REMOVED' | 'TASK_DUE_AT_UPDATED' | 'TASK_STATUS_UPDATED' | 'TASK_PRIORITY_UPDATED' | 'TASK_COMMENT_ADDED' | 'TASK_IMAGE_UPLOADED' | 'TASK_SITE_UPDATED' | 'TASK_DELETED' | 'TASK_CATEGORY_UPDATED' | 'INCIDENT_CREATED' | 'TASK_NOTIFICATION_SENT' | 'TASK_MEDIA_UPLOADED' | 'TASK_ASSIGNEE_UPDATED' | 'TASK_LOCATION_ADDED' | 'TASK_INSPECTION_COMPLETED' | 'TASK_INSPECTION_DELETED' | 'TASK_INSPECTION_ADDED' | 'TASK_ANSWER_ADDED' | 'TASK_ASSET_UPDATED' | 'TASK_LABELS_UPDATED' | 'TASK_SCHEDULE_UPDATED' | 'INCIDENT_CHILD_CREATED' | 'TASK_CUSTOM_FIELD_UPDATED' | 'TASK_OCCURRED_AT_UPDATED' | 'TASK_MEDIA_DELETED' — The type of the timeline item. - TIMELINE_ITEM_UNKNOWN: Removed fields related to the cancelled actions/issues integration An unknown type of timeline item. - TASK_CREATED: A timeline item for the creation of an action. - TASK_TITLE_UPDATED: A timeline item indicating that the title of the task has been updated. - TASK_DESCRIPTION_UPDATED: A timeline item indicating that the task's description has been updated. - TASK_ASSIGNEE_ADDED: A timeline item indicating that an assignee has been added to the task. - TASK_ASSIGNEE_REMOVED: A timeline item indicating that an assignee has been removed from the task. - TASK_DUE_AT_UPDATED: A timeline item indicating that the due date of the task has been updated. - TASK_STATUS_UPDATED: A timeline item indicating that the status of the task has been updated. - TASK_PRIORITY_UPDATED: A timeline item indicating that the priority of the task has been updated. - TASK_COMMENT_ADDED: A timeline item indicating that a comment has been added to the task. - TASK_IMAGE_UPLOADED: A timeline item indicating that an image was added to the task. This field is deprecated, and was replaced by the `TASK_MEDIA_ADDED` type. It is kept here to maintain backwards compatibility. @deprecated use TASK_MEDIA_UPLOADED instead - TASK_SITE_UPDATED: A timeline item indicating that the folder (site) of the task has been updated. - TASK_DELETED: A timeline item indicating that this task has been deleted. - TASK_CATEGORY_UPDATED: A timeline item indicating that the category of this task has been updated. This type is only relevant to issues. - INCIDENT_CREATED: A timeline item for the creation of an issue. - TASK_NOTIFICATION_SENT: A timeline item indicating that a notification about this task has been sent. - TASK_MEDIA_UPLOADED: A timeline item indicating that media has been added to this task. - TASK_ASSIGNEE_UPDATED: reserved 17, 18, 19; 17 - 19 reserved for the cancelled actions/issues integration feature. A timeline item indicating that the assignee of this task has been updated. - TASK_LOCATION_ADDED: A timeline item indicating the geolocation of this issue. This type is only relevant to issues. - TASK_INSPECTION_COMPLETED: A timeline item indicating that an inspection that has been linked to an issue has been completed. This type is only relevant to issues. - TASK_INSPECTION_DELETED: A timeline item indicating that an inspection that has been linked to an issue has been deleted. This type is only relevant to issues. - TASK_INSPECTION_ADDED: A timeline item indicating that an inspection has been linked to an issue. This type is only relevant to issues. - TASK_ANSWER_ADDED: A timeline item indicating that an issue's custom question has been answered. This type is only relevant to issues. - TASK_ASSET_UPDATED: A timeline item indicating that an action has an asset updated - TASK_LABELS_UPDATED: A timeline item indicating that an action has labels updated - TASK_SCHEDULE_UPDATED: A timeline item indicating that the schedule that created this action was updated. - INCIDENT_CHILD_CREATED: A timeline item indicating that an action has been created from an issue - TASK_CUSTOM_FIELD_UPDATED: A timeline item indicating that a custom field on this task was updated. - TASK_OCCURRED_AT_UPDATED: A timeline item indicating that occurred at date for the task has been updated. - TASK_MEDIA_DELETED: A timeline item indicating that media has been deleted from this task. - `task_created_data` S12TasksV1TimelineItemTaskCreatedMessageData — Data about when an action was created. - `task` S12TasksV1Task - `task_id` string — An ID uniquely identifying this task message. For example: 'aa70d8a6-af37-44f4-8768d8899fe274c5' - `creator` S12TasksV1TaskUser — The user associated to the task. They could be a creator or assignee. - `user_id` string — The UUID of this user. - `firstname` string — The first name of the user. - `lastname` string — The last name of the user. - `title` string — Title of this task - `description` string — Description of this task - `created_at` string, date-time — Date/time this task was created - `due_at` string, date-time — Date/time this task is due - `priority_id` string — Priority ID of this task - `status_id` string — Status ID of this task @deprecated. For task type of action use status instead. In use by task type of incident. - `collaborators` S12TasksV1TaskCollaborator[] — Collaborators of this task - `collaborator_id` string — A UUID uniquely identifying this collaborator. - `collaborator_type` 'USER' | 'GROUP' | 'EXTERNAL_USER' | 'CONTRIBUTOR' — - USER: The collaborator is an internal user. - GROUP: The collaborator is a group. - EXTERNAL_USER: The collaborator is an external user. This happens when a task is assigned to an email address. - CONTRIBUTOR: The collaborator is a contributor. A contributor is an individual who raises a task anonymously. For example, creating an incident through the incident QR code functionality. - `assigned_role` 'ASSIGNEE' | 'CREATOR' — - ASSIGNEE: The collaborator has been assigned to a task. - CREATOR: The collaborator has created the task. - `user` S12TasksV1TaskUser — The user associated to the task. They could be a creator or assignee. - `user_id` string — The UUID of this user. - `firstname` string — The first name of the user. - `lastname` string — The last name of the user. - `group` S12TasksV1TaskGroup — The group that is assigned to a task. - `group_id` string — The UUID of this group. - `name` string — The name of the group - `external_user` S12TasksV1TaskExternalUser — The external user that is assigned to a task. - `id` string — The UUID uniquely identifying this external user. - `email` string — The email address of the external user. - `contributor` S12TasksV1TaskContributor - `id` string — The UUID uniquely identifying this contributor - `name` string — Optional. The contributor's name. - `email` string — Optional. The contributor's email address. - `contact` string — Optional. The contributor's (freetext) contact details. - `template_id` string — Template ID of the inspection the action belongs to - `inspection` S12TasksV1TaskInspection - `inspection_id` string — ID of the inspection the action belongs to - `inspection_name` string — The name of the inspection the action belongs to - `inspection_item` S12TasksV1TaskInspectionItem - `inspection_item_id` string — ID of the item in the inspection associated with the action - `inspection_item_name` string — The name of the item in the inspection associated with the action - `inspection_item_type` string — The type of the item in the inspection associated with the action - `inspection_item_response_values` string[] — The labels of the responses - `site` S12TasksV1TaskSite — The folder (site) data of this task. - `id` string — The UUID of the site associated with this task. - `name` string — The name of the site associated with this task. - `region` string — The region of the site associated with the task. - `area` string — The area of the site associated with the task - `modified_at` string, date-time — Date/time this task was last modified - `references` S12TasksV1TaskReference[] — References on this task. - `type` 'SENSOR' | 'SENSOR_ALERT' | 'INSPECTION' | 'INCIDENT' | 'SCHEDULE' | 'ACTION' | 'LINKED_INSPECTION' | 'ASSET_MAINTENANCE_PLAN' — Reference type. The idea here is to list all the "external" types that would be used as a reference when creating actions. - `id` string — Required. Reference ID. - `inspection_context` S12TasksV1TaskInspectionContext - `inspection_id` string — ID of the inspection associated with the action - `inspection_name` string — name of the inspection associated with the action - `inspection_item_id` string — ID of the inspectionItem associated with the action - `inspection_item_name` string — name of the inspectionItem associated with the action - `inspection_item_type` string — @deprecated The type of the inspectionItem associated with the action - `inspection_item_path` string[] — The path(breadcrumbs) of the inspectionItem associated with the action - `inspection_item_attachments` S12TasksV1TaskAttachments - … - `list_answer` S12TasksV1TaskListAnswer - … - `text_answer` S12TasksV1TaskTextAnswer - … - `checkbox_answer` S12TasksV1TaskCheckboxAnswer - … - `media_answer` S12TasksV1TaskMediaAnswer - … - `signature_answer` S12TasksV1TaskSignatureAnswer - … - `drawing_answer` S12TasksV1TaskDrawingAnswer - … - `slider_answer` S12TasksV1TaskSliderAnswer - … - `datetime_answer` S12TasksV1TaskDateTimeAnswer - … - `address_answer` S12TasksV1TaskAddressAnswer - … - `switch_answer` S12TasksV1TaskSwitchAnswer — Answer returned for SwitchItem, exists in old inspections Users can’t change answer to them & can’t attach actions to them either. - … - `temperature_answer` S12TasksV1TaskTemperatureAnswer - … - `inspection_deleted` boolean — Flag indicated whether the inspection has been deleted - `sensor_alert_context` S12TasksV1TaskSensorAlertContext - `sensor_alert_id` string — ID of sensor alert context associated with the action - `level` 'OK' | 'INFO' | 'WARN' | 'CRITICAL' — - OK: `OK` level indicates that device metric became healthy - INFO: `INFO` level indicates that the first alert event sent - WARN: `WARN` level indicates that the second alert event sent - CRITICAL: `CRITICAL` level indicates that the third alert event sent - `created_at` string, date-time — The time the alert event was created/updated. - `detected_at` string, date-time — The time the first alert event was detected. - `sensor_id` string — Sensor asset ID for which the event happened - `site_name` string — Name of the site at a time of event - `metric_type` 'TEMPERATURE' | 'HUMIDITY' | 'BATTERY' | 'SIGNAL' | 'AIR_QUALITY_PM25' | 'AIR_QUALITY_PM10' | 'TEMPERATURE_2' | 'DIFFERENTIAL_AIR_PRESSURE' | 'CO' | 'DOOR_OPEN_CLOSED' | 'BATTERY_VOLTAGE' | 'WEATHER' | 'WIND_SPEED' | 'WIND_DIRECTION' | 'WIND_GUST' | 'CO2' — - TEMPERATURE: Temperature metric - HUMIDITY: Humidity metric - BATTERY: Battery level. Percentage based i.e. 0 - 100 - SIGNAL: Signal strength metric - AIR_QUALITY_PM25: Air quality for particulate matter less than 2.5 microns - AIR_QUALITY_PM10: Air quality for particulate matter less than 10 microns - TEMPERATURE_2: Alternative temperature (Some hardware i.e. Avem Quirks do have 2 probes and are sending 2 temperatures) - DIFFERENTIAL_AIR_PRESSURE: Differential air pressure - CO: Carbon monoxide - DOOR_OPEN_CLOSED: Door open/closed boolean metric - BATTERY_VOLTAGE: Battery voltage metric - WEATHER: Weather (e.g. sunny, thunderstorms) - WIND_SPEED: Wind speed - WIND_DIRECTION: Wind direction - WIND_GUST: Wind gust - CO2: Carbon dioxide - `sensor_name` string — Name of the sensor at a time of event - `reading_type` string — Sensor reading type - `reading_name` string — Sensor reading name - `sensor_context` S12TasksV1TaskSensorContext - `incident_context` S12TasksV1TaskIncidentContext - `title` string — Title of the incident - `description` string — Description of the incident - `creator` S12TasksV1TaskUser — The user associated to the task. They could be a creator or assignee. - … - `status_id` string — Status ID of the incident - `category_id` string — Category of the incident - `due_at` string, date-time — Date/time the incident is due - `priority_id` string — Priority ID of the incident - `unique_id` string — The human readable unique ID of the incident - `collaborators` S12TasksV1TaskCollaborator[] — The collaborators of the incident - … - `action_context` S12TasksV1TaskActionContext - `title` string — Title of the action - `description` string — Description of the action - `creator` S12TasksV1TaskUser — The user associated to the task. They could be a creator or assignee. - … - `status` S12TasksV1TaskStatus - … - `due_at` string, date-time — Date/time the action is due - `priority_id` string — Priority ID of the action - `unique_id` string — The human readable unique ID of the action - `collaborators` S12TasksV1TaskCollaborator[] — The collaborators of the action - … - `inspection` S12TasksV1TaskInspection - … - `type` S12TasksV1Type — The type associated with an action. - … - `linked_inspection_context` S12TasksV1TaskLinkedInspectionContext — Context of an inspection started from a template associated with the action. - `inspection_id` string — ID of the inspection associated with the action. - `template_id` string — ID of the template this inspection was created from. - `inspection_name` string — Name of the inspection linked to the action. - `is_complete` boolean — Flag to indicate the inspection is marked as complete. - `is_access_denied` boolean — Flag to indicate the access for the inspection is denied. - `is_deleted` boolean — Flag to indicate whether the inspection is deleted or not. - `created_at` string, date-time — The date the inspection was created. - `completed_at` string, date-time — The date the inspection was completed. - `template_name` string — Name of the template this inspection was created from. - `asset_maintenance_plan_context` S12TasksV1TaskAssetMaintenancePlanContext - `maintenance_plan` S12TasksV1TaskAssetMaintenancePlan — AssetMaintenancePlan represents the maintenance plan associated with the action. - … - `maintenance_program` S12TasksV1TaskAssetMaintenanceProgram — AssetMaintenanceProgram represents the maintenance program where the maintenance plan belongs. - … - `completed_at` string, date-time — Date/time this task was completed at - `template_name` string — Template name of the inspection the action belongs to - `status` S12TasksV1TaskStatus - `status_id` string — An ID uniquely identifying this task status message. For example: 'aa70d8a6-af37-44f4-8768d8899fe274c5' - `key` string — A pre-defined value that the system can use to handle the particular label e.g. analytics, filter based on it A key may look like: "to do" | "In progress" | "Done" | "Can't do" - `label` string — A label associated with the key, typically for display purposes - `display_order` integer — Used to order this status when displaying a list of statuses - `asset_id` string — @deprecated Asset ID of this task - `asset` S12TasksV1TaskAsset - `id` string — The UUID of the asset associated with this task. - `code` string — The code of the asset associated with this task. - `type_id` string — The id of the asset type associated with this task. - `action_label` S12TasksV1ActionLabel[] — Label of a task - `label_id` string — (Required) The UUID of the action label. For example, "73361b5d-407a-424e-b20e-c932bc41706c". - `label_name` string — (Required) The name of the action label. - `unique_id` string — The human readable unique ID of the task - `type` 'TASK_TYPE_ACTION' | 'TASK_TYPE_CUSTOM' — - TASK_TYPE_ACTION: Indicates this task is of type Action. - TASK_TYPE_CUSTOM: Indicates this task is of a custom type. - `occurred_at` string, date-time — Date/time this task occurred at - `task_templates` S12TasksV1TaskTemplate[] — The list of templates linked to the action. - `template_id` string — The unique identifier of the template. - `name` string — Custom defined template name. - `is_deleted` boolean - `is_archived` boolean - `is_access_denied` boolean - `owner_id` string — The id of the owner of the template - `task_assignee_added_data` S12TasksV1TimelineItemTaskAssigneeAddedMessageData — Data about when an assignee was added to the task. - `collaborators` S12TasksV1TaskCollaborator[] — Data about the people assigned to the task. - `collaborator_id` string — A UUID uniquely identifying this collaborator. - `collaborator_type` 'USER' | 'GROUP' | 'EXTERNAL_USER' | 'CONTRIBUTOR' — - USER: The collaborator is an internal user. - GROUP: The collaborator is a group. - EXTERNAL_USER: The collaborator is an external user. This happens when a task is assigned to an email address. - CONTRIBUTOR: The collaborator is a contributor. A contributor is an individual who raises a task anonymously. For example, creating an incident through the incident QR code functionality. - `assigned_role` 'ASSIGNEE' | 'CREATOR' — - ASSIGNEE: The collaborator has been assigned to a task. - CREATOR: The collaborator has created the task. - `user` S12TasksV1TaskUser — The user associated to the task. They could be a creator or assignee. - `user_id` string — The UUID of this user. - `firstname` string — The first name of the user. - `lastname` string — The last name of the user. - `group` S12TasksV1TaskGroup — The group that is assigned to a task. - `group_id` string — The UUID of this group. - `name` string — The name of the group - `external_user` S12TasksV1TaskExternalUser — The external user that is assigned to a task. - `id` string — The UUID uniquely identifying this external user. - `email` string — The email address of the external user. - `contributor` S12TasksV1TaskContributor - `id` string — The UUID uniquely identifying this contributor - `name` string — Optional. The contributor's name. - `email` string — Optional. The contributor's email address. - `contact` string — Optional. The contributor's (freetext) contact details. - `task_due_at_updated_data` S12TasksV1TimelineItemTaskDueAtUpdatedMessageData — Data about when the due date of a task was changed. - `due_at` string, date-time — The new due date of the task. - `task_status_updated_data` S12TasksV1TimelineItemTaskStatusUpdatedMessageData — Data about when the status of a task was updated. - `status_id` string — The new status UUID of the task. - `task_priority_updated_data` S12TasksV1TimelineItemTaskPriorityUpdatedMessageData — Data about when the priority of a task was updated. - `priority_id` string — The new priority UUID of the task. - `task_comment_added_data` S12TasksV1TimelineItemTaskCommentAddedMessageData — Data about when a comment is added to a task. - `comment` string — The text value of the comment. - `task_image_uploaded_data` S12TasksV1TimelineItemTaskImageUploadedMessageData — Data about when an image was added to a task. @deprecated This has been deprecated in favour of media messages. This is because the media messages allow videos and PDF as well as images. - `media` S12CommonMedia - `id` string - `token` string - `filename` string — full file name, including file extension - `media_type` 'MEDIA_TYPE_IMAGE' | 'MEDIA_TYPE_VIDEO' | 'MEDIA_TYPE_PDF' | 'MEDIA_TYPE_DOCX' | 'MEDIA_TYPE_XLSX' | 'MEDIA_TYPE_PPTX' | 'MEDIA_TYPE_CSV' — - MEDIA_TYPE_IMAGE: An image file (GIF, JPG, PNG, WEBP). - MEDIA_TYPE_VIDEO: A video file (MP4, MOV). - MEDIA_TYPE_PDF: A PDF document. - MEDIA_TYPE_DOCX: A Microsoft Word document (DOCX, DOC). - MEDIA_TYPE_XLSX: A Microsoft Excel spreadsheet (XLSX, XLS). - MEDIA_TYPE_PPTX: A Microsoft PowerPoint presentation (PPTX, PPT). - MEDIA_TYPE_CSV: A CSV file. - `task_site_updated_data` S12TasksV1TimelineItemTaskSiteUpdatedMessageData — Data about when the folder (site) of this task was updated. - `site` S12TasksV1TaskSite — The folder (site) data of this task. - `id` string — The UUID of the site associated with this task. - `name` string — The name of the site associated with this task. - `region` string — The region of the site associated with the task. - `area` string — The area of the site associated with the task - `site_hierarchy` S12TasksV1TaskSite[] — Information about the hierarchy of the site. This is ordered in ascending order, ie: Site -> Area -> Region -> State -> Country. - `id` string — The UUID of the site associated with this task. - `name` string — The name of the site associated with this task. - `region` string — The region of the site associated with the task. - `area` string — The area of the site associated with the task - `task_category_updated_data` S12TasksV1TimelineItemTaskCategoryUpdatedMessageData — Data about when an issue's category was updated. - `category_id` string — @deprecated. Use category instead. ID of the category of the task that was updated. The field has been deprecated, as more information about the category is in the `category` field. - `category` S12TasksV1Category — A category is used to classify an issue. For example, you can filter issues by category for analytics, or give users or groups access to issues from a category. - `id` string — The UUID of a category. - `key` string — The name of a category. This can be a default name or one that is customized in your organization. - `label` string — The name of a category. This field's value is the same as the value for `key`. - `description` string — The description of a category. - `display_order` integer — The sorting order of a list of categories. This is unused, and is hardcoded as `0`. - `is_visible` boolean — The indicator for whether a category is visible or not for an organization on the web app and the mobile app. - `use_category_access_whitelist` boolean — The indicator for whether a category's issues can be accessed by anyone in your organization or not. If this is `false` for a category, then that category's issues can only be accessed by creators and assignees. - `items` S12TasksV1Item[] — List of all items to be used in the category - `id` string — The UUID of the item. - `name` string — Name of the item - `is_mandatory` boolean — Whether or not the item must be filled before submission - `type` 'ITEM_TYPE_UNSPECIFIED' | 'ITEM_TYPE_TITLE' | 'ITEM_TYPE_DESCRIPTION' | 'ITEM_TYPE_SITE' | 'ITEM_TYPE_MEDIA' | 'ITEM_TYPE_LOCATION' | 'ITEM_TYPE_QUESTION' | 'ITEM_TYPE_OCCURRED_AT' | 'ITEM_TYPE_ASSET' — - ITEM_TYPE_UNSPECIFIED: The item type is unspecified - `question_data` S12TasksV1Question — Question represents the question structure for a custom question. - `id` string — The UUID of the question. - `text` string — The text of the question being asked (e.g. "How many eggs are in a dozen?"). This does not use the new `validator.string` option as question processing logic fails when symbols are substituted for similar-looking symbols. - `type` 'QUESTION_TYPE_UNSPECIFIED' | 'QUESTION_TYPE_TEXT' | 'QUESTION_TYPE_MULTIPLE_CHOICE' — - QUESTION_TYPE_UNSPECIFIED: The question type is unspecified. This generally should not happen. - QUESTION_TYPE_TEXT: The question is text type. This question accepts freetext answers. - QUESTION_TYPE_MULTIPLE_CHOICE: The question is multiple choice. This question provides a list of options to choose from. - `is_mandatory` boolean — Whether the question is mandatory or not - `multiple_choice_options` S12TasksV1MultipleChoiceOptions — MultipleChoiceOptions is an explicit message for a set of MultipleChoiceOption's to use in a oneof field below. - … - `is_disabled` boolean — Whether or not the item is disabled and hidden from submission - `notification_detail` 'CATEGORY_NOTIFICATION_DETAIL_UNSPECIFIED' | 'CATEGORY_NOTIFICATION_DETAIL_PRIVATE' | 'CATEGORY_NOTIFICATION_DETAIL_SUMMARY' | 'CATEGORY_NOTIFICATION_DETAIL_FULL' — CategoryNotificationDetail represents the different level of detail for category notifications. - CATEGORY_NOTIFICATION_DETAIL_UNSPECIFIED: CATEGORY_NOTIFICATION_DETAIL_UNSPECIFIED is the default value and should not be used. - CATEGORY_NOTIFICATION_DETAIL_PRIVATE: CATEGORY_NOTIFICATION_DETAIL_PRIVATE notifications will be restricted to public metadata. - CATEGORY_NOTIFICATION_DETAIL_SUMMARY: CATEGORY_NOTIFICATION_DETAIL_SUMMARY notifications will include public and private metadata. - CATEGORY_NOTIFICATION_DETAIL_FULL: CATEGORY_NOTIFICATION_DETAIL_FULL will include all metadata and detailed responses. - `linked_template_ids` string[] — The list of template ids linked to this category. - `visibility_summary` S12TasksV1CategoryVisibilitySummary - `users` integer — The number of users that are the category is directly visible to - `groups` integer — The number of groups that the category is directly visible to - `sites` integer — The number of sites that the category is directly visible to - `user_access_as_reporter` 'CATEGORY_USER_ACCESS_AS_REPORTER_UNSPECIFIED' | 'CATEGORY_USER_ACCESS_AS_REPORTER_ALWAYS' | 'CATEGORY_USER_ACCESS_AS_REPORTER_NEVER' | 'CATEGORY_USER_ACCESS_AS_REPORTER_WHEN_SITE_MEMBER' - `incident_created_data` S12TasksV1TimelineItemIncidentCreatedMessageData — Data about when an issue was created. - `incident` S12TasksV1Incident — An Incident represents the details of an issue. This can include the category, any attached media, the location, any linked inspections and the task associated with the issue. - `task` S12TasksV1Task - `task_id` string — An ID uniquely identifying this task message. For example: 'aa70d8a6-af37-44f4-8768d8899fe274c5' - `creator` S12TasksV1TaskUser — The user associated to the task. They could be a creator or assignee. - `user_id` string — The UUID of this user. - `firstname` string — The first name of the user. - `lastname` string — The last name of the user. - `title` string — Title of this task - `description` string — Description of this task - `created_at` string, date-time — Date/time this task was created - `due_at` string, date-time — Date/time this task is due - `priority_id` string — Priority ID of this task - `status_id` string — Status ID of this task @deprecated. For task type of action use status instead. In use by task type of incident. - `collaborators` S12TasksV1TaskCollaborator[] — Collaborators of this task - `collaborator_id` string — A UUID uniquely identifying this collaborator. - `collaborator_type` 'USER' | 'GROUP' | 'EXTERNAL_USER' | 'CONTRIBUTOR' — - USER: The collaborator is an internal user. - GROUP: The collaborator is a group. - EXTERNAL_USER: The collaborator is an external user. This happens when a task is assigned to an email address. - CONTRIBUTOR: The collaborator is a contributor. A contributor is an individual who raises a task anonymously. For example, creating an incident through the incident QR code functionality. - `assigned_role` 'ASSIGNEE' | 'CREATOR' — - ASSIGNEE: The collaborator has been assigned to a task. - CREATOR: The collaborator has created the task. - `user` S12TasksV1TaskUser — The user associated to the task. They could be a creator or assignee. - … - `group` S12TasksV1TaskGroup — The group that is assigned to a task. - … - `external_user` S12TasksV1TaskExternalUser — The external user that is assigned to a task. - … - `contributor` S12TasksV1TaskContributor - … - `template_id` string — Template ID of the inspection the action belongs to - `inspection` S12TasksV1TaskInspection - `inspection_id` string — ID of the inspection the action belongs to - `inspection_name` string — The name of the inspection the action belongs to - `inspection_item` S12TasksV1TaskInspectionItem - `inspection_item_id` string — ID of the item in the inspection associated with the action - `inspection_item_name` string — The name of the item in the inspection associated with the action - `inspection_item_type` string — The type of the item in the inspection associated with the action - `inspection_item_response_values` string[] — The labels of the responses - `site` S12TasksV1TaskSite — The folder (site) data of this task. - `id` string — The UUID of the site associated with this task. - `name` string — The name of the site associated with this task. - `region` string — The region of the site associated with the task. - `area` string — The area of the site associated with the task - `modified_at` string, date-time — Date/time this task was last modified - `references` S12TasksV1TaskReference[] — References on this task. - `type` 'SENSOR' | 'SENSOR_ALERT' | 'INSPECTION' | 'INCIDENT' | 'SCHEDULE' | 'ACTION' | 'LINKED_INSPECTION' | 'ASSET_MAINTENANCE_PLAN' — Reference type. The idea here is to list all the "external" types that would be used as a reference when creating actions. - `id` string — Required. Reference ID. - `inspection_context` S12TasksV1TaskInspectionContext - … - `sensor_alert_context` S12TasksV1TaskSensorAlertContext - … - `sensor_context` S12TasksV1TaskSensorContext - `incident_context` S12TasksV1TaskIncidentContext - … - `action_context` S12TasksV1TaskActionContext - … - `linked_inspection_context` S12TasksV1TaskLinkedInspectionContext — Context of an inspection started from a template associated with the action. - … - `asset_maintenance_plan_context` S12TasksV1TaskAssetMaintenancePlanContext - … - `completed_at` string, date-time — Date/time this task was completed at - `template_name` string — Template name of the inspection the action belongs to - `status` S12TasksV1TaskStatus - `status_id` string — An ID uniquely identifying this task status message. For example: 'aa70d8a6-af37-44f4-8768d8899fe274c5' - `key` string — A pre-defined value that the system can use to handle the particular label e.g. analytics, filter based on it A key may look like: "to do" | "In progress" | "Done" | "Can't do" - `label` string — A label associated with the key, typically for display purposes - `display_order` integer — Used to order this status when displaying a list of statuses - `asset_id` string — @deprecated Asset ID of this task - `asset` S12TasksV1TaskAsset - `id` string — The UUID of the asset associated with this task. - `code` string — The code of the asset associated with this task. - `type_id` string — The id of the asset type associated with this task. - `action_label` S12TasksV1ActionLabel[] — Label of a task - `label_id` string — (Required) The UUID of the action label. For example, "73361b5d-407a-424e-b20e-c932bc41706c". - `label_name` string — (Required) The name of the action label. - `unique_id` string — The human readable unique ID of the task - `type` 'TASK_TYPE_ACTION' | 'TASK_TYPE_CUSTOM' — - TASK_TYPE_ACTION: Indicates this task is of type Action. - TASK_TYPE_CUSTOM: Indicates this task is of a custom type. - `occurred_at` string, date-time — Date/time this task occurred at - `task_templates` S12TasksV1TaskTemplate[] — The list of templates linked to the action. - `template_id` string — The unique identifier of the template. - `name` string — Custom defined template name. - `is_deleted` boolean - `is_archived` boolean - `is_access_denied` boolean - `owner_id` string — The id of the owner of the template - `category_id` string — @deprecated. Use category instead. The category id associated with the issue. - `category` S12TasksV1Category — A category is used to classify an issue. For example, you can filter issues by category for analytics, or give users or groups access to issues from a category. - `id` string — The UUID of a category. - `key` string — The name of a category. This can be a default name or one that is customized in your organization. - `label` string — The name of a category. This field's value is the same as the value for `key`. - `description` string — The description of a category. - `display_order` integer — The sorting order of a list of categories. This is unused, and is hardcoded as `0`. - `is_visible` boolean — The indicator for whether a category is visible or not for an organization on the web app and the mobile app. - `use_category_access_whitelist` boolean — The indicator for whether a category's issues can be accessed by anyone in your organization or not. If this is `false` for a category, then that category's issues can only be accessed by creators and assignees. - `items` S12TasksV1Item[] — List of all items to be used in the category - `id` string — The UUID of the item. - `name` string — Name of the item - `is_mandatory` boolean — Whether or not the item must be filled before submission - `type` 'ITEM_TYPE_UNSPECIFIED' | 'ITEM_TYPE_TITLE' | 'ITEM_TYPE_DESCRIPTION' | 'ITEM_TYPE_SITE' | 'ITEM_TYPE_MEDIA' | 'ITEM_TYPE_LOCATION' | 'ITEM_TYPE_QUESTION' | 'ITEM_TYPE_OCCURRED_AT' | 'ITEM_TYPE_ASSET' — - ITEM_TYPE_UNSPECIFIED: The item type is unspecified - `question_data` S12TasksV1Question — Question represents the question structure for a custom question. - … - `is_disabled` boolean — Whether or not the item is disabled and hidden from submission - `notification_detail` 'CATEGORY_NOTIFICATION_DETAIL_UNSPECIFIED' | 'CATEGORY_NOTIFICATION_DETAIL_PRIVATE' | 'CATEGORY_NOTIFICATION_DETAIL_SUMMARY' | 'CATEGORY_NOTIFICATION_DETAIL_FULL' — CategoryNotificationDetail represents the different level of detail for category notifications. - CATEGORY_NOTIFICATION_DETAIL_UNSPECIFIED: CATEGORY_NOTIFICATION_DETAIL_UNSPECIFIED is the default value and should not be used. - CATEGORY_NOTIFICATION_DETAIL_PRIVATE: CATEGORY_NOTIFICATION_DETAIL_PRIVATE notifications will be restricted to public metadata. - CATEGORY_NOTIFICATION_DETAIL_SUMMARY: CATEGORY_NOTIFICATION_DETAIL_SUMMARY notifications will include public and private metadata. - CATEGORY_NOTIFICATION_DETAIL_FULL: CATEGORY_NOTIFICATION_DETAIL_FULL will include all metadata and detailed responses. - `linked_template_ids` string[] — The list of template ids linked to this category. - `visibility_summary` S12TasksV1CategoryVisibilitySummary - `users` integer — The number of users that are the category is directly visible to - `groups` integer — The number of groups that the category is directly visible to - `sites` integer — The number of sites that the category is directly visible to - `user_access_as_reporter` 'CATEGORY_USER_ACCESS_AS_REPORTER_UNSPECIFIED' | 'CATEGORY_USER_ACCESS_AS_REPORTER_ALWAYS' | 'CATEGORY_USER_ACCESS_AS_REPORTER_NEVER' | 'CATEGORY_USER_ACCESS_AS_REPORTER_WHEN_SITE_MEMBER' - `media` S12CommonMedia[] — Any media associated with this issue. - `id` string - `token` string - `filename` string — full file name, including file extension - `media_type` 'MEDIA_TYPE_IMAGE' | 'MEDIA_TYPE_VIDEO' | 'MEDIA_TYPE_PDF' | 'MEDIA_TYPE_DOCX' | 'MEDIA_TYPE_XLSX' | 'MEDIA_TYPE_PPTX' | 'MEDIA_TYPE_CSV' — - MEDIA_TYPE_IMAGE: An image file (GIF, JPG, PNG, WEBP). - MEDIA_TYPE_VIDEO: A video file (MP4, MOV). - MEDIA_TYPE_PDF: A PDF document. - MEDIA_TYPE_DOCX: A Microsoft Word document (DOCX, DOC). - MEDIA_TYPE_XLSX: A Microsoft Excel spreadsheet (XLSX, XLS). - MEDIA_TYPE_PPTX: A Microsoft PowerPoint presentation (PPTX, PPT). - MEDIA_TYPE_CSV: A CSV file. - `location` S12TasksV1TaskAddressLocation — The location of the task. The latitude and longitude in the `geo_position` object are required. All other fields are optional, but add extra context to the location on platform. - `name` string — The name of the task's location. - `thoroughfare` string — The thoroughfare of the location. - `sub_thoroughfare` string — The sub_thoroughfare of the location, - `locality` string — The locality of the location - `sub_locality` string — The sub_locality of the location - `administrative_area` string — The administrative_area of the location - `sub_administrative_area` string — The sub_administrative_area of the location - `postal_code` string — The postal_code of the location - `country` string — The country of the location - `iso_country_code` string — The iso_country_code of the location - `geo_position` S12CommonGeoPosition — A position is the fundamental geographical geometry construct. - `longitude` number, double — The geographical longitude - `latitude` number, double — The geographical latitude - `accuracy` integer — The accuracy in meters - `inspections` S12TasksV1Inspection[] — The inspections that are linked to this issue. - `id` string — The ID of the linked inspection. This may or may not be a UUID, so we don't validate it here. - `created_at` string, date-time — The date the inspection was created. - `status` 'INSPECTION_STATUS_UNSPECIFIED' | 'INSPECTION_STATUS_IN_PROGRESS' | 'INSPECTION_STATUS_COMPLETED' | 'INSPECTION_STATUS_DELETED' — - INSPECTION_STATUS_UNSPECIFIED: The status of the inspection is unspecified - INSPECTION_STATUS_IN_PROGRESS: The status of the inspection is 'In Progress' - INSPECTION_STATUS_COMPLETED: The status of the inspection is 'Completed' - INSPECTION_STATUS_DELETED: The status of the inspection is 'Deleted' - `title` string — The title of the inspection - `template_title` string — The title of the template that this inspection was created from - `items` S12TasksV1Item[] — A snapshot of the category items, at the time of creation. - `id` string — The UUID of the item. - `name` string — Name of the item - `is_mandatory` boolean — Whether or not the item must be filled before submission - `type` 'ITEM_TYPE_UNSPECIFIED' | 'ITEM_TYPE_TITLE' | 'ITEM_TYPE_DESCRIPTION' | 'ITEM_TYPE_SITE' | 'ITEM_TYPE_MEDIA' | 'ITEM_TYPE_LOCATION' | 'ITEM_TYPE_QUESTION' | 'ITEM_TYPE_OCCURRED_AT' | 'ITEM_TYPE_ASSET' — - ITEM_TYPE_UNSPECIFIED: The item type is unspecified - `question_data` S12TasksV1Question — Question represents the question structure for a custom question. - `id` string — The UUID of the question. - `text` string — The text of the question being asked (e.g. "How many eggs are in a dozen?"). This does not use the new `validator.string` option as question processing logic fails when symbols are substituted for similar-looking symbols. - `type` 'QUESTION_TYPE_UNSPECIFIED' | 'QUESTION_TYPE_TEXT' | 'QUESTION_TYPE_MULTIPLE_CHOICE' — - QUESTION_TYPE_UNSPECIFIED: The question type is unspecified. This generally should not happen. - QUESTION_TYPE_TEXT: The question is text type. This question accepts freetext answers. - QUESTION_TYPE_MULTIPLE_CHOICE: The question is multiple choice. This question provides a list of options to choose from. - `is_mandatory` boolean — Whether the question is mandatory or not - `multiple_choice_options` S12TasksV1MultipleChoiceOptions — MultipleChoiceOptions is an explicit message for a set of MultipleChoiceOption's to use in a oneof field below. - … - `is_disabled` boolean — Whether or not the item is disabled and hidden from submission - `question_answers` S12TasksV1QuestionAnswers[] — The answers to the snapshot category items - `question_id` string — The ID of the question - `answer_set` S12TasksV1Answer[] — The set of answers that is associated with the question. - `answer_text` S12TasksV1AnswerText — A type of answer for a custom question containing text data. - … - `answer_multiple_choice_option` S12TasksV1MultipleChoiceOption — MultipleChoiceOption represents a possible answer for a multiple choice question. - … - `answer_id` string — The ID of the answer. - `answered_at` string, date-time — Date and time the question was answered. - `ai_generated` boolean — True when this issue was created via an AI-assisted flow. Set from the client at submit time and persisted on the issue. Top-level marker for EU AI Act Article 50(2) machine-readable detectability (AI-522). - `task_notification_sent_data` S12TasksV1TimelineItemTaskNotificationSentMessageData — Data about when a notification is sent about a task. - `group_id` string[] — UUIDs for any groups that received a notification in this timeline item. IDs that belong to the task's specific category. This is deprecated in favour of the `groups` field. - `groups` S12TasksV1Group[] — Data about any groups who received a notification in this timeline item. - `id` string - `name` string - `users` S12TasksV1TaskUser[] — Data about any individual users who received a notification in this timeline item. - `user_id` string — The UUID of this user. - `firstname` string — The first name of the user. - `lastname` string — The last name of the user. - `external_users` S12TasksV1TaskExternalUser[] — Data about any external users who received a notification in this timeline item. - `id` string — The UUID uniquely identifying this external user. - `email` string — The email address of the external user. - `site_groups` S12TasksV1Group[] — Groups that received a notification due to site based notification configuration. - `id` string - `name` string - `site` S12TasksV1TaskSite — The folder (site) data of this task. - `id` string — The UUID of the site associated with this task. - `name` string — The name of the site associated with this task. - `region` string — The region of the site associated with the task. - `area` string — The area of the site associated with the task - `is_critical` boolean — Whether or not the notifications were sent as critical - `task_media_uploaded_data` S12TasksV1TimelineItemTaskMediaUploadedMessageData — Data about when media files were added to the task. - `media` S12CommonMedia[] — Data about the media that were added at this time. Users can add multiple pieces of media at once, so this may contain data about multiple pieces of media. - `id` string - `token` string - `filename` string — full file name, including file extension - `media_type` 'MEDIA_TYPE_IMAGE' | 'MEDIA_TYPE_VIDEO' | 'MEDIA_TYPE_PDF' | 'MEDIA_TYPE_DOCX' | 'MEDIA_TYPE_XLSX' | 'MEDIA_TYPE_PPTX' | 'MEDIA_TYPE_CSV' — - MEDIA_TYPE_IMAGE: An image file (GIF, JPG, PNG, WEBP). - MEDIA_TYPE_VIDEO: A video file (MP4, MOV). - MEDIA_TYPE_PDF: A PDF document. - MEDIA_TYPE_DOCX: A Microsoft Word document (DOCX, DOC). - MEDIA_TYPE_XLSX: A Microsoft Excel spreadsheet (XLSX, XLS). - MEDIA_TYPE_PPTX: A Microsoft PowerPoint presentation (PPTX, PPT). - MEDIA_TYPE_CSV: A CSV file. - `deleted_ids` string[] — IDs of media items previously associated with this activity that have since been deleted. - `task_assignee_updated_data` S12TasksV1TimelineItemTaskAssigneeUpdatedMessageData — Data about when an assignee was updated. - `assignees` S12TasksV1TaskCollaborator[] — Assignees of the task that was updated. - `collaborator_id` string — A UUID uniquely identifying this collaborator. - `collaborator_type` 'USER' | 'GROUP' | 'EXTERNAL_USER' | 'CONTRIBUTOR' — - USER: The collaborator is an internal user. - GROUP: The collaborator is a group. - EXTERNAL_USER: The collaborator is an external user. This happens when a task is assigned to an email address. - CONTRIBUTOR: The collaborator is a contributor. A contributor is an individual who raises a task anonymously. For example, creating an incident through the incident QR code functionality. - `assigned_role` 'ASSIGNEE' | 'CREATOR' — - ASSIGNEE: The collaborator has been assigned to a task. - CREATOR: The collaborator has created the task. - `user` S12TasksV1TaskUser — The user associated to the task. They could be a creator or assignee. - `user_id` string — The UUID of this user. - `firstname` string — The first name of the user. - `lastname` string — The last name of the user. - `group` S12TasksV1TaskGroup — The group that is assigned to a task. - `group_id` string — The UUID of this group. - `name` string — The name of the group - `external_user` S12TasksV1TaskExternalUser — The external user that is assigned to a task. - `id` string — The UUID uniquely identifying this external user. - `email` string — The email address of the external user. - `contributor` S12TasksV1TaskContributor - `id` string — The UUID uniquely identifying this contributor - `name` string — Optional. The contributor's name. - `email` string — Optional. The contributor's email address. - `contact` string — Optional. The contributor's (freetext) contact details. - `task_location_added_data` S12TasksV1TimelineItemTaskLocationAddedMessageData — Data about when a location is added to a task. - `location` S12TasksV1TaskAddressLocation — The location of the task. The latitude and longitude in the `geo_position` object are required. All other fields are optional, but add extra context to the location on platform. - `name` string — The name of the task's location. - `thoroughfare` string — The thoroughfare of the location. - `sub_thoroughfare` string — The sub_thoroughfare of the location, - `locality` string — The locality of the location - `sub_locality` string — The sub_locality of the location - `administrative_area` string — The administrative_area of the location - `sub_administrative_area` string — The sub_administrative_area of the location - `postal_code` string — The postal_code of the location - `country` string — The country of the location - `iso_country_code` string — The iso_country_code of the location - `geo_position` S12CommonGeoPosition — A position is the fundamental geographical geometry construct. - `longitude` number, double — The geographical longitude - `latitude` number, double — The geographical latitude - `accuracy` integer — The accuracy in meters - `task_inspection_completed_data` S12TasksV1TimelineItemTaskInspectionCompletedMessageData — Data about when an inspection linked to this issue is completed. - `inspection_id` string — ID of the completed inspection. - `template_title` string — The title of the template this inspection was created from. - `task_inspection_deleted_data` S12TasksV1TimelineItemTaskInspectionDeletedMessageData — Data about when an inspection linked to this issue was deleted. - `inspection_id` string — ID of the deleted inspection. - `template_title` string — The title of the template this inspection was created from. - `task_inspection_added_data` S12TasksV1TimelineItemTaskInspectionAddedMessageData — Data about when an inspection is linked to this issue. - `inspection_id` string — ID of the inspection that is being added - `template_title` string — Title of template being added - `task_answer_added_data` S12TasksV1TimelineItemTaskAnswerAddedMessageData — Data about when a custom question was answered on this issue. - `question_text` string — The text of the question that was answered. - `answer_text` string — The text of the answer that was provided. - `type` 'QUESTION_TYPE_UNSPECIFIED' | 'QUESTION_TYPE_TEXT' | 'QUESTION_TYPE_MULTIPLE_CHOICE' — - QUESTION_TYPE_UNSPECIFIED: The question type is unspecified. This generally should not happen. - QUESTION_TYPE_TEXT: The question is text type. This question accepts freetext answers. - QUESTION_TYPE_MULTIPLE_CHOICE: The question is multiple choice. This question provides a list of options to choose from. - `task_asset_updated_data` S12TasksV1TimelineItemTaskAssetUpdatedMessageData — Data about when the asset of this task was updated. - `asset_id` string — The UUID of an Asset assigned to a task - `asset_code` string — Asset code - `task_labels_updated_data` S12TasksV1TimelineItemTaskLabelsUpdatedMessageData — Data about when labels were updated on this action. - `label_texts` string[] — The texts of the labels that were updated. If empty, any assigned labels were cleared. - `task_schedule_updated_data` S12TasksV1TimelineItemTaskScheduleUpdatedMessageData - `schedule_id` string — The ID of the schedule that was updated - `task_custom_field_updated_data` S12TasksV1TimelineItemTaskCustomFieldUpdatedMessageData - `field_id` string — The ID of the field that was updated - `field_name` string — The name of the field that was updated - `task_occurred_at_updated_data` S12TasksV1TimelineItemTaskOccurredAtUpdatedMessageData — Data about when the occurred at date of the task was updated. - `occurred_at` string, date-time — The new occurred at date of the task. - `task_media_deleted_data` S12TasksV1TimelineItemTaskMediaDeletedMessageData — Data about when a media file was deleted from the task. - `media` S12CommonMedia - `id` string - `token` string - `filename` string — full file name, including file extension - `media_type` 'MEDIA_TYPE_IMAGE' | 'MEDIA_TYPE_VIDEO' | 'MEDIA_TYPE_PDF' | 'MEDIA_TYPE_DOCX' | 'MEDIA_TYPE_XLSX' | 'MEDIA_TYPE_PPTX' | 'MEDIA_TYPE_CSV' — - MEDIA_TYPE_IMAGE: An image file (GIF, JPG, PNG, WEBP). - MEDIA_TYPE_VIDEO: A video file (MP4, MOV). - MEDIA_TYPE_PDF: A PDF document. - MEDIA_TYPE_DOCX: A Microsoft Word document (DOCX, DOC). - MEDIA_TYPE_XLSX: A Microsoft Excel spreadsheet (XLSX, XLS). - MEDIA_TYPE_PPTX: A Microsoft PowerPoint presentation (PPTX, PPT). - MEDIA_TYPE_CSV: A CSV file. - `activity_creator` S12TasksV1TimelineItemActivityCreator — Creator of the timeline item. - `id` string — The UUID of the individual who created this timeline item. - `name` string — The name of the individual who created this timeline item. - `creator_type` 'TYPE_NOT_SET' | 'INTERNAL_USER' | 'EXTERNAL_USER' — The type of individual who has created this timeline item. - TYPE_NOT_SET: An unknown type of creator. - INTERNAL_USER: The creator is an authenticated user within the organisation. - EXTERNAL_USER: The creator is an unauthenticated user who has been given external access to the task. ## Other responses - `default` — An unexpected error response. --- [API](https://skmtc.net/safetyculture/apis/safetyculture-api.md) · [All operations](https://skmtc.net/safetyculture/apis/safetyculture-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/safetyculture/safetyculture-api/revisions/5be91df61ded/schema)