--- title: "List Investigations" method: GET path: "/incidents/v1/investigations" tags: ["Investigations"] --- # List Investigations `GET /incidents/v1/investigations` ## Query parameters - `search` string - `filters.investigation_ids.values` string[] - `filters.status_ids.values` string[] - `filters.site_ids.values` string[] - `filters.title.term` string - `filters.title.match_behaviour` 'MatchBehaviourPartial' | 'MatchBehaviourExact' - `filters.description.term` string - `filters.description.match_behaviour` 'MatchBehaviourPartial' | 'MatchBehaviourExact' - `filters.created_at.from` string, date-time - `filters.created_at.to` string, date-time - `filters.modified_at.from` string, date-time - `filters.modified_at.to` string, date-time - `filters.created_by.values` string[] - `filters.owned_by.values` string[] - `filters.linked_issue_ids.values` string[] - `filters.linked_action_ids.values` string[] - `filters.linked_inspection_ids.values` string[] - `filters.category_ids.values` string[] - `sort.field` 'InvestigationsSortFieldCreatedAt' | 'InvestigationsSortFieldModifiedAt' | 'InvestigationsSortFieldTitle' | 'InvestigationsSortFieldStatus' | 'InvestigationsSortFieldUniqueID' | 'InvestigationsSortFieldCategoryName' - `sort.order` 'InvestigationsSortOrderAsc' | 'InvestigationsSortOrderDesc' - `page_size` integer, required - `page_token` string ## Response `200` A successful response. - S12IncidentsV1ListInvestigationsResponse - `results` S12IncidentsV1InvestigationListItem[] — the list of results - `investigation_id` string — unique identifier for the investigation - `created_at` string, date-time — created timestamp for the investigation - `modified_at` string, date-time — last modified timestamp for the investigation - `title` string — title of the investigation - `description` string — description of the investigation - `status` S12IncidentsV1StatusMeta - `status_id` string — unique identifier for the status - `title` string — Deprecated. Use title_localised instead. title of the status - `badge_color` 'StatusBadgeColorAccent' | 'StatusBadgeColorInfo' | 'StatusBadgeColorNegative' | 'StatusBadgeColorPositive' | 'StatusBadgeColorWarning' | 'StatusBadgeColorSurface' — - StatusBadgeColorAccent: Color is accent - StatusBadgeColorInfo: Color is info - StatusBadgeColorNegative: Color is negative - StatusBadgeColorPositive: Color is positive - StatusBadgeColorWarning: Color is warning - StatusBadgeColorSurface: Color is surface - `title_localised` S12IncidentsV1LocalisedString - `value` string — The string value that has been matched - `lang` string — The matched language which has been used to provided the value - `alternatives` S12IncidentsV1LocalisedStringSet - `strings` object — The map of BCP47 language codes to string content - `order` string[] — The ordered list of BCP47 language codes. 0th index acts as the default if no languages could be matched - `identifier` S12IncidentsV1Identifier - `prefix` string — prefix for the unique identifier e.g. IM - `sequence` integer — sequence number for the unique identifier e.g. 100 - `for_display` string — identifier data formatted for display e.g. IM-100 - `creator` S12IncidentsV1UserMeta - `user_id` string — unique identifier for the user - `display_name` string — name of the user - `profile_image` 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. - `email` string — email address of the user - `seat_type` 'SUBSCRIPTION_SEAT_TYPE_UNSPECIFIED' | 'SUBSCRIPTION_SEAT_TYPE_PREMIUM' | 'SUBSCRIPTION_SEAT_TYPE_COLLABORATOR' | 'SUBSCRIPTION_SEAT_TYPE_LITE' | 'SUBSCRIPTION_SEAT_TYPE_SERVICE_USER' | 'SUBSCRIPTION_SEAT_TYPE_SUPPORT' - `status` 'USER_ACTIVE_STATUS_UNSPECIFIED' | 'USER_ACTIVE_STATUS_ACTIVE' | 'USER_ACTIVE_STATUS_DEACTIVATED' — - USER_ACTIVE_STATUS_UNSPECIFIED: Status is unknown or not specified - USER_ACTIVE_STATUS_ACTIVE: User is active - USER_ACTIVE_STATUS_DEACTIVATED: User has been deactivated - `timezone` string — the timezone of the user - `owner` S12IncidentsV1UserMeta - `user_id` string — unique identifier for the user - `display_name` string — name of the user - `profile_image` 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. - `email` string — email address of the user - `seat_type` 'SUBSCRIPTION_SEAT_TYPE_UNSPECIFIED' | 'SUBSCRIPTION_SEAT_TYPE_PREMIUM' | 'SUBSCRIPTION_SEAT_TYPE_COLLABORATOR' | 'SUBSCRIPTION_SEAT_TYPE_LITE' | 'SUBSCRIPTION_SEAT_TYPE_SERVICE_USER' | 'SUBSCRIPTION_SEAT_TYPE_SUPPORT' - `status` 'USER_ACTIVE_STATUS_UNSPECIFIED' | 'USER_ACTIVE_STATUS_ACTIVE' | 'USER_ACTIVE_STATUS_DEACTIVATED' — - USER_ACTIVE_STATUS_UNSPECIFIED: Status is unknown or not specified - USER_ACTIVE_STATUS_ACTIVE: User is active - USER_ACTIVE_STATUS_DEACTIVATED: User has been deactivated - `timezone` string — the timezone of the user - `link_counts` S12IncidentsV1LinkCounts - `total_actions` integer — total count of linked actions - `open_actions` integer — count of linked actions which are open - `closed_actions` integer — count of linked actions which are closed - `user_actions` S12IncidentsV1InvestigationUserActions — Updates against core fields - `set_title` boolean — user can set the title - `set_description` boolean — user can set the description - `set_status` boolean — user can set the status - `list_access` boolean — user can list users with access - `update_access` boolean — user can update access - `change_owner` boolean — user can change owner - `list_actions` boolean — user can list actions - `count_actions` boolean — user can count actions - `link_action` boolean — user can link action - `unlink_action` boolean — user can unlink action - `list_issues` boolean — user can list issues - `count_issues` boolean — user can count issues - `link_issue` boolean — user can link issues - `unlink_issue` boolean — user can unlink issues - `list_media` boolean — user can list media - `count_media` boolean — user can count media - `add_media` boolean — user can add media - `remove_media` boolean — user can remove media - `list_inspections` boolean — user can list inspections - `count_inspections` boolean — user can count inspections - `link_inspection` boolean — user can link inspections - `unlink_inspection` boolean — user can unlink inspections - `generate_pdf_report` boolean — user can generate a PDF report - `can_delete` boolean — user can delete the investigation - `edit_field` boolean — user can edit a field on the investigation - `delete_field` boolean — user can delete a field on the investigation - `modified_by` S12IncidentsV1UserMeta - `user_id` string — unique identifier for the user - `display_name` string — name of the user - `profile_image` 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. - `email` string — email address of the user - `seat_type` 'SUBSCRIPTION_SEAT_TYPE_UNSPECIFIED' | 'SUBSCRIPTION_SEAT_TYPE_PREMIUM' | 'SUBSCRIPTION_SEAT_TYPE_COLLABORATOR' | 'SUBSCRIPTION_SEAT_TYPE_LITE' | 'SUBSCRIPTION_SEAT_TYPE_SERVICE_USER' | 'SUBSCRIPTION_SEAT_TYPE_SUPPORT' - `status` 'USER_ACTIVE_STATUS_UNSPECIFIED' | 'USER_ACTIVE_STATUS_ACTIVE' | 'USER_ACTIVE_STATUS_DEACTIVATED' — - USER_ACTIVE_STATUS_UNSPECIFIED: Status is unknown or not specified - USER_ACTIVE_STATUS_ACTIVE: User is active - USER_ACTIVE_STATUS_DEACTIVATED: User has been deactivated - `timezone` string — the timezone of the user - `user_flags` S12IncidentsV1InvestigationUserFlags - `read_only` boolean — User is accessing an investigation which is 'read only' for them - `is_owner` boolean — User is the owner of the investigation - `category` S12IncidentsV1CategoryMetaData - `category_id` string — the unique identifier of the category - `title` string — the title of the category - `description` string — the description of the category - `detail_fields` S12IncidentsV1DetailFieldContent[] — detail fields for the investigation - `field_id` string — unique identifier for the detail field - `title` string — title of the detail field - `data_type` 'FIELD_VALUE_TYPE_UNSPECIFIED' | 'FIELD_VALUE_TYPE_STRING' | 'FIELD_VALUE_TYPE_MONEY' | 'FIELD_VALUE_TYPE_TIMESTAMP' | 'FIELD_VALUE_TYPE_USER_ID' | 'FIELD_VALUE_TYPE_SELECT' | 'FIELD_VALUE_TYPE_TEMPLATE_ID' | 'FIELD_VALUE_TYPE_MULTI_SELECT' | 'FIELD_VALUE_TYPE_SITE' | 'FIELD_VALUE_TYPE_MULTI_SITE' | 'FIELD_VALUE_TYPE_INTEGER' | 'FIELD_VALUE_TYPE_ADDRESS' | 'FIELD_VALUE_TYPE_TIMEZONE' | 'FIELD_VALUE_TYPE_CONTACT_DETAILS' — Type of FieldValue. Defaults to type String. - FIELD_VALUE_TYPE_UNSPECIFIED: Field value type unspecified. - FIELD_VALUE_TYPE_STRING: Field value type string. - FIELD_VALUE_TYPE_MONEY: Field value type money. - FIELD_VALUE_TYPE_TIMESTAMP: Field value type timestamp. - FIELD_VALUE_TYPE_USER_ID: Field value type user ID. - FIELD_VALUE_TYPE_SELECT: Field value type select - FIELD_VALUE_TYPE_TEMPLATE_ID: Field value type template ID. - FIELD_VALUE_TYPE_MULTI_SELECT: Field value type multi-select - FIELD_VALUE_TYPE_SITE: Field value type site - FIELD_VALUE_TYPE_MULTI_SITE: Field value type multi-site - FIELD_VALUE_TYPE_INTEGER: Field value type integer - FIELD_VALUE_TYPE_ADDRESS: Field value type address. - FIELD_VALUE_TYPE_TIMEZONE: Field value type timezone - FIELD_VALUE_TYPE_CONTACT_DETAILS: Field value type contact details - `single_select` S12IncidentsV1SingleSelectDetailFieldContent - `selected` string — the selected option - `options` string[] — the repeated list of string options available - `multi_select` S12IncidentsV1MultiSelectDetailFieldContent - `selected` string[] — the selected options - `options` string[] — the repeated list of string options available - `date_time` S12IncidentsV1DateTimeDetailFieldContent - `datetime` string, date-time — the datetime content - `site` S12IncidentsV1SiteDetailFieldContent - `uuid` string — the uuid content - `name` string — the human-readable name of the site - `multi_site` S12IncidentsV1MultiSiteDetailFieldContent - `uuid` string[] — the uuid content - `names` object — the human-readable names of the sites - `category_title_at_creation` string — original category title at creation time - `next_page_token` string — a token which can be used to fetch further results ## 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)