--- title: "List Issues" method: POST path: "/tasks/v1/incidents/list" tags: ["Issues"] --- # List Issues `POST /tasks/v1/incidents/list` ## Request body - S12TasksV1GetIncidentsRequest — GetIncidentsRequest represents the parameters to `GetIncidents`. - `page_size` integer — Optional. Number of issues to be returned in a single request. This must be a value between 1 and 100, any values outside of this range will be ignored. The presence of `next_page_token` in the response indicates that more results might be available. - `page_token` string — Optional. If present, then retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call. This can be used to retrieve more than 100 issues with multiple API calls. For example: 'ODFBMzQ3MDYtNzQxNy00RDZGLThDNjE1MEFDMkM4MTQ3NDQ=' - `sort_field` 'SORT_FIELD_UNKNOWN' | 'PRIORITY' | 'DATE_DUE' | 'CREATED_AT' | 'MODIFIED_AT' | 'OCCURRED_AT' — The options available to sort the issues by. By default, the issues will be returned by the date they were last modified in descending order. This should be used in combination with `SortDirection` to determine how issues are sorted. If either `SortField` or `SortDirection` is missing, the default sort order will be used. - SORT_FIELD_UNKNOWN: `SORT_FIELD_UNKNOWN` will return the default sort order. - PRIORITY: `PRIORITY` will sort the issues by incident priority. - DATE_DUE: `DATE_DUE` will sort the issues by due date. - CREATED_AT: `CREATED_AT` will sort the issues by the date they were created. - MODIFIED_AT: `MODIFIED_AT` will sort the issues by the date they were last modified. - OCCURRED_AT: `OCCURRED_AT` will sort the issues by the date they occurred at. - `sort_direction` 'SORT_DIRECTION_UNKNOWN' | 'ASC' | 'DESC' — The options available to define the sort direction. - SORT_DIRECTION_UNKNOWN: `SORT_DIRECTION_UNKNOWN` will return the default sort direction. - ASC: `ASC` will return the sorted issues in ascending order. - DESC: `DESC` will return the sorted issues in descending order. - `filters` S12TasksV1GetIncidentsRequestFilter[] — Optional. An array of filters can be provided in the request to filter the issues. - `status_id` S12TasksV1GetIncidentsRequestFilterStatusID — Will return issues that have a matching status. An issue can be open or resolved, and these are represented by hardcoded UUID values. Open status: `547ed646-5e34-4732-bb54-a199d304368a`. Resolved status: `450484b1-56cd-4784-9b49-a3cf97d0c0ad`. - `operator` 'FILTER_OPERATOR_UNKNOWN' | 'IN' — The options available when defining a filter. The only available option is `IN`. - FILTER_OPERATOR_UNKNOWN: `FILTER_OPERATOR_UNKNOWN` represents the default value for a filter operator, which is `IN`. - IN: `IN` returns results where the value is a direct match. - `value` string[] — The ID of the status. - `priority_id` S12TasksV1GetIncidentsRequestFilterPriorityID — Will return issues that have a matching priority. The priority of an issue can be one of four options: none, low, medium or high. Each of these are represented by a hardcoded UUID value. No priority: `58941717-817f-4c7c-a6f6-5cd05e2bbfde`. Low priority: `16ba4717-adc9-4d48-bf7c-044cfe0d2727`. Medium priority: `ce87c58a-eeb2-4fde-9dc4-c6e85f1f4055`. High priority: `02eb40c1-4f46-40c5-be16-d32941c96ec9`. - `operator` 'FILTER_OPERATOR_UNKNOWN' | 'IN' — The options available when defining a filter. The only available option is `IN`. - FILTER_OPERATOR_UNKNOWN: `FILTER_OPERATOR_UNKNOWN` represents the default value for a filter operator, which is `IN`. - IN: `IN` returns results where the value is a direct match. - `value` string[] — The ID of the priority. - `category_id` S12TasksV1GetIncidentsRequestFilterCategoryID — Will return issues that have a matching category. - `operator` 'FILTER_OPERATOR_UNKNOWN' | 'IN' — The options available when defining a filter. The only available option is `IN`. - FILTER_OPERATOR_UNKNOWN: `FILTER_OPERATOR_UNKNOWN` represents the default value for a filter operator, which is `IN`. - IN: `IN` returns results where the value is a direct match. - `value` string[] — The ID of the category. - `site_id` S12TasksV1GetIncidentsRequestFilterSiteID — Will return issues that have a matching site. - `operator` 'FILTER_OPERATOR_UNKNOWN' | 'IN' — The options available when defining a filter. The only available option is `IN`. - FILTER_OPERATOR_UNKNOWN: `FILTER_OPERATOR_UNKNOWN` represents the default value for a filter operator, which is `IN`. - IN: `IN` returns results where the value is a direct match. - `value` string[] — The ID of the site. - `assignee_id` S12TasksV1GetIncidentsRequestFilterAssigneeID — Will return issues where the user ID of the assignee matches the provided value. - `operator` 'FILTER_OPERATOR_UNKNOWN' | 'IN' — The options available when defining a filter. The only available option is `IN`. - FILTER_OPERATOR_UNKNOWN: `FILTER_OPERATOR_UNKNOWN` represents the default value for a filter operator, which is `IN`. - IN: `IN` returns results where the value is a direct match. - `value` string[] — The user ID of the assignee. - `creator_id` S12TasksV1GetIncidentsRequestFilterCreatorID — Will return issues where the user ID of the creator matches the provided value. - `operator` 'FILTER_OPERATOR_UNKNOWN' | 'IN' — The options available when defining a filter. The only available option is `IN`. - FILTER_OPERATOR_UNKNOWN: `FILTER_OPERATOR_UNKNOWN` represents the default value for a filter operator, which is `IN`. - IN: `IN` returns results where the value is a direct match. - `value` string[] — The user ID of the creator. - `title` S12TasksV1GetIncidentsRequestFilterSearch — Will return issues where the title and/or description contain the search term. - `term` string — `term` represents the text to search for. - `description` S12TasksV1GetIncidentsRequestFilterSearch — Will return issues where the title and/or description contain the search term. - `term` string — `term` represents the text to search for. - `task_id` S12TasksV1GetIncidentsRequestFilterTaskID - `operator` 'FILTER_OPERATOR_UNKNOWN' | 'IN' — The options available when defining a filter. The only available option is `IN`. - FILTER_OPERATOR_UNKNOWN: `FILTER_OPERATOR_UNKNOWN` represents the default value for a filter operator, which is `IN`. - IN: `IN` returns results where the value is a direct match. - `value` string[] — OR relation, represents the task_id should be one of the value provided - `due_at` S12TasksV1GetIncidentsRequestFilterDuration - `from` string, date-time — optional. represents the time should be after the time provided - `to` string, date-time — optional. represents the time should be before the time provided - `created_at` S12TasksV1GetIncidentsRequestFilterDuration - `from` string, date-time — optional. represents the time should be after the time provided - `to` string, date-time — optional. represents the time should be before the time provided - `occurred_at` S12TasksV1GetIncidentsRequestFilterDuration - `from` string, date-time — optional. represents the time should be after the time provided - `to` string, date-time — optional. represents the time should be before the time provided - `keyword` S12TasksV1GetIncidentsRequestFilterSearch — Will return issues where the title and/or description contain the search term. - `term` string — `term` represents the text to search for. - `modified_at` S12TasksV1GetIncidentsRequestFilterDuration - `from` string, date-time — optional. represents the time should be after the time provided - `to` string, date-time — optional. represents the time should be before the time provided - `completed_at` S12TasksV1GetIncidentsRequestFilterDuration - `from` string, date-time — optional. represents the time should be after the time provided - `to` string, date-time — optional. represents the time should be before the time provided - `asset_id` S12TasksV1GetIncidentsRequestFilterAssetID - `operator` 'FILTER_OPERATOR_UNKNOWN' | 'IN' — The options available when defining a filter. The only available option is `IN`. - FILTER_OPERATOR_UNKNOWN: `FILTER_OPERATOR_UNKNOWN` represents the default value for a filter operator, which is `IN`. - IN: `IN` returns results where the value is a direct match. - `value` string[] — OR relation, represents the asset_id should be one of the value provided ## Response `200` A successful response. - S12TasksV1IncidentsResponse - `incidents` S12TasksV1Incident[] — List of issues - `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 - `note` string — Note inside Attachments of inspectionItem Answer - `media` S12CommonMedia[] — images or pdf inside Attachments of inspectionItem Answer - … - `list_answer` S12TasksV1TaskListAnswer - `responses` S12TasksV1TaskListResponse[] — Responses of inspection item - … - `text_answer` S12TasksV1TaskTextAnswer - `answer` string — Text answer content - `unit_symbol` 'MEASUREMENT_UNIT_SYMBOL_KILOMETERS' | 'MEASUREMENT_UNIT_SYMBOL_MILES' | 'MEASUREMENT_UNIT_SYMBOL_HOURS' | 'MEASUREMENT_UNIT_SYMBOL_MINUTES' | 'MEASUREMENT_UNIT_SYMBOL_INCHES' | 'MEASUREMENT_UNIT_SYMBOL_FOOT' | 'MEASUREMENT_UNIT_SYMBOL_MILLIMETERS' | 'MEASUREMENT_UNIT_SYMBOL_CENTIMETERS' | 'MEASUREMENT_UNIT_SYMBOL_METERS' | 'MEASUREMENT_UNIT_SYMBOL_MILLILITRES' | 'MEASUREMENT_UNIT_SYMBOL_LITRES' | 'MEASUREMENT_UNIT_SYMBOL_GALLONS' | 'MEASUREMENT_UNIT_SYMBOL_CUBIC_METERS' | 'MEASUREMENT_UNIT_SYMBOL_SECONDS' | 'MEASUREMENT_UNIT_SYMBOL_FAHRENHEIT' | 'MEASUREMENT_UNIT_SYMBOL_CELSIUS' | 'MEASUREMENT_UNIT_SYMBOL_KELVIN' | 'MEASUREMENT_UNIT_SYMBOL_OUNCE' | 'MEASUREMENT_UNIT_SYMBOL_POUNDS' | 'MEASUREMENT_UNIT_SYMBOL_TONNES' | 'MEASUREMENT_UNIT_SYMBOL_GRAMS' | 'MEASUREMENT_UNIT_SYMBOL_KILOGRAMS' | 'MEASUREMENT_UNIT_SYMBOL_AMPERES' | 'MEASUREMENT_UNIT_SYMBOL_HERTZ' | 'MEASUREMENT_UNIT_SYMBOL_OHM' | 'MEASUREMENT_UNIT_SYMBOL_VOLTS' | 'MEASUREMENT_UNIT_SYMBOL_WATTS' | 'MEASUREMENT_UNIT_SYMBOL_CANDELA' | 'MEASUREMENT_UNIT_SYMBOL_CYCLES' | 'MEASUREMENT_UNIT_SYMBOL_PERCENT' | 'MEASUREMENT_UNIT_SYMBOL_POUNDS_PER_SQUARE_INCH' | 'MEASUREMENT_UNIT_SYMBOL_MOLE' | 'MEASUREMENT_UNIT_SYMBOL_DAYS' | 'MEASUREMENT_UNIT_SYMBOL_WEEKS' | 'MEASUREMENT_UNIT_SYMBOL_MONTHS' — Collection of symbols (km, mi, hr, etc) used in units of measurement. - MEASUREMENT_UNIT_SYMBOL_KILOMETERS: Measurement unit symbol for kilometers. - MEASUREMENT_UNIT_SYMBOL_MILES: Measurement unit symbol for miles. - MEASUREMENT_UNIT_SYMBOL_HOURS: Measurement unit symbol for hours. - MEASUREMENT_UNIT_SYMBOL_MINUTES: Measurement unit symbol for minutes. - MEASUREMENT_UNIT_SYMBOL_INCHES: Measurement unit symbol for inches. - MEASUREMENT_UNIT_SYMBOL_FOOT: Measurement unit symbol for foot. - MEASUREMENT_UNIT_SYMBOL_MILLIMETERS: Measurement unit symbol for Millimeters. - MEASUREMENT_UNIT_SYMBOL_CENTIMETERS: Measurement unit symbol for Centimeters. - MEASUREMENT_UNIT_SYMBOL_METERS: Measurement unit symbol for meters. - MEASUREMENT_UNIT_SYMBOL_MILLILITRES: Measurement unit symbol for millilitres. - MEASUREMENT_UNIT_SYMBOL_LITRES: Measurement unit symbol for litres. - MEASUREMENT_UNIT_SYMBOL_GALLONS: Measurement unit symbol for gallons. - MEASUREMENT_UNIT_SYMBOL_CUBIC_METERS: Measurement unit symbol for cubic meters. - MEASUREMENT_UNIT_SYMBOL_SECONDS: Measurement unit symbol for seconds. - MEASUREMENT_UNIT_SYMBOL_FAHRENHEIT: Measurement unit symbol for fahrenheit. - MEASUREMENT_UNIT_SYMBOL_CELSIUS: Measurement unit symbol for celsius. - MEASUREMENT_UNIT_SYMBOL_KELVIN: Measurement unit symbol for kelvin. - MEASUREMENT_UNIT_SYMBOL_OUNCE: Measurement unit symbol for ounce. - MEASUREMENT_UNIT_SYMBOL_POUNDS: Measurement unit symbol for pounds. - MEASUREMENT_UNIT_SYMBOL_TONNES: Measurement unit symbol for tonnes. - MEASUREMENT_UNIT_SYMBOL_GRAMS: Measurement unit symbol for grams. - MEASUREMENT_UNIT_SYMBOL_KILOGRAMS: Measurement unit symbol for kilograms. - MEASUREMENT_UNIT_SYMBOL_AMPERES: Measurement unit symbol for amperes. - MEASUREMENT_UNIT_SYMBOL_HERTZ: Measurement unit symbol for hertz. - MEASUREMENT_UNIT_SYMBOL_OHM: Measurement unit symbol for ohm. - MEASUREMENT_UNIT_SYMBOL_VOLTS: Measurement unit symbol for volts. - MEASUREMENT_UNIT_SYMBOL_WATTS: Measurement unit symbol for watts. - MEASUREMENT_UNIT_SYMBOL_CANDELA: Measurement unit symbol for candela. - MEASUREMENT_UNIT_SYMBOL_CYCLES: Measurement unit symbol for cycles. - MEASUREMENT_UNIT_SYMBOL_PERCENT: Measurement unit symbol for percent. - MEASUREMENT_UNIT_SYMBOL_POUNDS_PER_SQUARE_INCH: Measurement unit symbol for pounds per square inch. - MEASUREMENT_UNIT_SYMBOL_MOLE: Measurement unit symbol for mole. - MEASUREMENT_UNIT_SYMBOL_DAYS: Measurement unit symbol for days. - MEASUREMENT_UNIT_SYMBOL_WEEKS: Measurement unit symbol for weeks. - MEASUREMENT_UNIT_SYMBOL_MONTHS: Measurement unit symbol for months. - `format` 'TEXT' | 'NUMBER' — - TEXT: Normal textsingle item - NUMBER: Textsingle item with number format - `checkbox_answer` S12TasksV1TaskCheckboxAnswer - `answer` boolean — answer content for CheckboxAnswer - `media_answer` S12TasksV1TaskMediaAnswer - `media` S12CommonMedia[] — answer content of MediaItem - … - `signature_answer` S12TasksV1TaskSignatureAnswer - `media` S12CommonMedia - … - `name` string — name on the signature - `signed_at` string, date-time — Timestamp for when the signature answer was last updated - `drawing_answer` S12TasksV1TaskDrawingAnswer - `media` S12CommonMedia - … - `slider_answer` S12TasksV1TaskSliderAnswer - `answer` number, double — number of sliderAnswer - `max` number, double — A double representing the maximum value allowed for this item. Negatives are allowed. - `min` number, double — A double representing the minimum value allowed for this item. Negatives are allowed. - `datetime_answer` S12TasksV1TaskDateTimeAnswer - `answer` string, date-time — answer content for DateTimeItem - `enable_date` boolean — Enable date turns on input for date values - `enable_time` boolean — Enable date turns on input for time values - `address_answer` S12TasksV1TaskAddressAnswer - `location_text` string — Location text - `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. - … - `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. - `answer` boolean — Answer content for SwitchItem - `temperature_answer` S12TasksV1TaskTemperatureAnswer - `temperature` number, double — @deprecated. Use answer instead - `display_unit` 'KELVIN' | 'CELSIUS' | 'FAHRENHEIT' — - KELVIN: Represents Kelvin temperature unit - CELSIUS: Represents Celsius temperature unit - FAHRENHEIT: Represents Fahrenheit temperature unit - `between` S12TasksV1TaskRangeComparison — Used to compare values within a range. - … - `above` S12TasksV1TaskNumberComparison — Used to compare values against a single number. - … - `below` S12TasksV1TaskNumberComparison — Used to compare values against a single number. - … - `answer` number, double — answer of TemperatureAnswer - `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. - `user_id` string — The UUID of this user. - `firstname` string — The first name of the user. - `lastname` string — The last name of the user. - `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 - `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 - … - `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. - `user_id` string — The UUID of this user. - `firstname` string — The first name of the user. - `lastname` string — The last name of the user. - `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 - `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 - `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 - … - `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 - `type` S12TasksV1Type — The type associated with an action. - `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. - `id` string — The unique identifier of a type. - `name` string — The name of a type. - `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. - `id` string — The ID of the maintenance plan. - `name` string — The name of the maintenance plan. - `state` 'ASSET_MAINTENANCE_PLAN_STATE_UNSPECIFIED' | 'ASSET_MAINTENANCE_PLAN_STATE_ACTIVE' | 'ASSET_MAINTENANCE_PLAN_STATE_DELETED' — - ASSET_MAINTENANCE_PLAN_STATE_UNSPECIFIED: ASSET_MAINTENANCE_PLAN_STATE_UNSPECIFIED is an unknown maintenance plan state. - ASSET_MAINTENANCE_PLAN_STATE_ACTIVE: ASSET_MAINTENANCE_PLAN_STATE_ACTIVE is a maintenance plan state that is active. - ASSET_MAINTENANCE_PLAN_STATE_DELETED: ASSET_MAINTENANCE_PLAN_STATE_DELETED is a maintenance plan state that is deleted. - `maintenance_program` S12TasksV1TaskAssetMaintenanceProgram — AssetMaintenanceProgram represents the maintenance program where the maintenance plan belongs. - `id` string — The ID of the maintenance program. - `name` string — The name of the maintenance program. - `state` 'ASSET_MAINTENANCE_PROGRAM_STATE_UNSPECIFIED' | 'ASSET_MAINTENANCE_PROGRAM_STATE_ACTIVE' | 'ASSET_MAINTENANCE_PROGRAM_STATE_DELETED' — - ASSET_MAINTENANCE_PROGRAM_STATE_UNSPECIFIED: ASSET_MAINTENANCE_PROGRAM_STATE_UNSPECIFIED is an unknown maintenance program state. - ASSET_MAINTENANCE_PROGRAM_STATE_ACTIVE: ASSET_MAINTENANCE_PROGRAM_STATE_ACTIVE is a maintenance program state that is active. - ASSET_MAINTENANCE_PROGRAM_STATE_DELETED: ASSET_MAINTENANCE_PROGRAM_STATE_DELETED is a maintenance program state that is deleted. - `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. - `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. - `options` S12TasksV1MultipleChoiceOption[] - … - `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. - `options` S12TasksV1MultipleChoiceOption[] - `id` string — The UUID of the multiple choice option. - `text` string — The text of the multiple choice option. This does not use the new `validator.string` option as question processing logic fails when symbols are substituted for similar-looking symbols. - `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. - `text` string — The text that answers the question. - `answer_multiple_choice_option` S12TasksV1MultipleChoiceOption — MultipleChoiceOption represents a possible answer for a multiple choice question. - `id` string — The UUID of the multiple choice option. - `text` string — The text of the multiple choice option. This does not use the new `validator.string` option as question processing logic fails when symbols are substituted for similar-looking symbols. - `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). - `next_page_token` string — If there are more results than those appearing in this response, then `next_page_token` is included. If empty then there are no more results. To get the next set of results, call `GetIncidents` method again using the value of `next_page_token` as `page_token`. For Example: 'ODFBMzQ3MDYtNzQxNy00RDZGLThDNjE1MEFDMkM4MTQ3NDQ=' - `total` integer — @deprecated: Use `GetIncidentsCount` instead. Total number of issues found ## 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)