--- title: "List permission sets" method: POST path: "/permissions/v1/permission_sets" tags: ["Users"] --- # List permission sets `POST /permissions/v1/permission_sets` ## Request body - S12PermissionsV1ListPermissionSetsRequest — The request for ListPermissionSets. - `search` string — Search input to filter down the permission sets. - `sort` S12PermissionsV1PermissionSetSort — The parameters to sort permission sets by (criteria and order). - `criteria` 'PERMISSION_SET_SORT_CRITERIA_UNSPECIFIED' | 'PERMISSION_SET_SORT_CRITERIA_DEFAULT' | 'PERMISSION_SET_SORT_CRITERIA_NAME' | 'PERMISSION_SET_SORT_CRITERIA_MIN_SEAT_TYPE' | 'PERMISSION_SET_SORT_CRITERIA_LAST_MODIFIED' — The possible criteria to sort permission sets by. - PERMISSION_SET_SORT_CRITERIA_UNSPECIFIED: Unspecified sort. - PERMISSION_SET_SORT_CRITERIA_DEFAULT: Sort by the default order, which may or may not be equivalent as any other option. - PERMISSION_SET_SORT_CRITERIA_NAME: Sort by name. - PERMISSION_SET_SORT_CRITERIA_MIN_SEAT_TYPE: Sort by minimum seat type. - PERMISSION_SET_SORT_CRITERIA_LAST_MODIFIED: Sort by last modified date. - `order` 'PERMISSION_SET_ORDER_UNSPECIFIED' | 'PERMISSION_SET_ORDER_ASC' | 'PERMISSION_SET_ORDER_DESC' — The possible sort orders for permission sets. - PERMISSION_SET_ORDER_UNSPECIFIED: Unspecified order. - PERMISSION_SET_ORDER_ASC: Ascending order. - PERMISSION_SET_ORDER_DESC: Descending order. - `prioritise_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' - `include_users` boolean — Whether to include users in the response. - `limit` integer — The maximum number of permission sets to return. - `offset` integer — The offset of the first permission set to return. - `filters` S12PermissionsV1ListPermissionSetsFilter[] — (Optional). The filters to apply. - `type` 'PERMISSION_SET_TYPE_UNSPECIFIED' | 'PERMISSION_SET_TYPE_DEFAULT' | 'PERMISSION_SET_TYPE_CUSTOM' — The possible types of permission sets. - PERMISSION_SET_TYPE_UNSPECIFIED: Unspecified permission set type. - PERMISSION_SET_TYPE_DEFAULT: Default permission set. - PERMISSION_SET_TYPE_CUSTOM: Custom permission set. - `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' ## Response `200` A successful response. - S12PermissionsV1ListPermissionSetsResponse — The response for ListPermissionSets. - `permission_sets` S12PermissionsV1PermissionSetWithUsers[] — The permission sets. - `permission_set` S12PermissionsV1PermissionSet — PermissionSet represents a permission set. - `identifier` S12PermissionsV1PermissionSetIdentifier — Identifier for a permission set. - `id` string — The ID of the permission set. - `type` 'PERMISSION_SET_TYPE_UNSPECIFIED' | 'PERMISSION_SET_TYPE_DEFAULT' | 'PERMISSION_SET_TYPE_CUSTOM' — The possible types of permission sets. - PERMISSION_SET_TYPE_UNSPECIFIED: Unspecified permission set type. - PERMISSION_SET_TYPE_DEFAULT: Default permission set. - PERMISSION_SET_TYPE_CUSTOM: Custom permission set. - `name` string — The name of the permission set. - `description` string — The description of the permission set. - `allowed_seat_types` S12CommonSubscriptionSeatTypes[] — The seat types allowed for the permission set. The first element is the "minimum" allowed seat type. - `supports_email_less` boolean — Whether the permission set is applicable to users without an email-based username. False when the set grants any permission that is denylisted for non-email usernames (e.g. billing). Server-computed; ignored on writes. - `modified_at` string, date-time — Last modification time of the permission set. - `permissions` S12PermissionsV1Permissions — Permissions represents a set of permissions. Individual permissions can be omitted to leave them unchanged. - `manage_role` boolean — Permission representing "Admin" - `billing` boolean — Permission representing "Billing management" - `manage_folders` boolean — Permission representing "Site management" - `create_children` boolean — Permission representing "Group management" - `manage_users` boolean — Permission representing "User management" - `allow_modify_manage_data` boolean — Permission representing "Data management" - `manage_data` boolean — Permission representing "Data access" - `allow_mobile_data_access_sync` boolean — Permission representing "Mobile data access" - `create_template` boolean — Permission representing "Template creation" - `manage_response_sets` boolean — Permission representing "Manage response sets" - `share_public_library` boolean — Permission representing "Upload to Public Library" - `manage_report_preferences` boolean — Permission representing "Manage global report layouts" - `create_schedules` boolean — Permission representing "Schedule creation" - `manage_schedules` boolean — Permission representing "Schedule management" - `manage_incidents` boolean — Permission representing "Issues management" - `incident_access` boolean — Permission representing "Issues access" - `manage_sensors` boolean — Permission representing "Sensor management" - `view_sensors` boolean — Permission representing "Sensors access" - `create_heads_up` boolean — Permission representing "Create Heads up" - `manage_assets` boolean — Permission representing "Assets management" - `view_assets` boolean — Permission representing "Assets access" - `view_training` boolean — Permission representing "Training access" - `manage_tasks` boolean — Permission representing "Manage tasks" - `new_report_experience` boolean — Permission representing "New report experience" Should not be used in new cases. Returned only for backwards compat. - `manage_training` boolean — Permission representing "Training management" - `create_training` boolean — Permission representing "Training creation" - `manage_permissions` boolean — Permission representing "Permission management" - `view_analytics` boolean — Permission representing "Analytics access" - `create_analytics` boolean — Permission representing "Analytics report creation (creator-based)" - `create_site_analytics` boolean — Permission representing "Analytics report creation (site-based)" - `manage_analytics` boolean — Permission representing "Analytics management" - `settings_assets` boolean — Permission representing "Assets settings" - `manage_credentials` boolean — Permission representing "Credentials" - `create_course` boolean — Permission representing "Course creation" - `admin_resources` boolean — Permission representing "Resources Administration" - `manage_training_teams` boolean — Permission representing "Manage Teams" - `manage_companies` boolean — Permission representing "Manage Companies" - `manage_assets_media` boolean — Permission representing "Manage Assets media" - `manage_assets_maintenance` boolean — Permission representing "Manage Assets maintenance" - `settings_lone_worker` boolean — Permission representing "Lone worker settings" - `manage_lone_worker` boolean — Permission representing "Manage Lone Workers" - `access_lone_worker` boolean — Permission representing "Access Lone Workers" - `access_investigations` boolean — Permission representing "Create Investigations" - `manage_investigations` boolean — Permission representing "Manage Investigations" - `manage_heads_up` boolean — Permission representing "Manage Heads Up" - `configuration_investigations` boolean — Permission representing "Configuration Investigations" - `view_investigations` boolean — Permission representing "Read Investigations" - `access_osha` boolean — Permission representing "Access OSHA" - `view_inductions` boolean — Permission representing "Access Onboarding" - `access_ai_assistant` boolean — Permission representing "Access AI Assistant" - `manage_fields` boolean — Permission representing "Manage Fields" - `manage_content_library_publish` boolean — Permission representing "Content Library Publish" - `admin_manufacturing` boolean — Permission representing "Manufacturing Admin" - `operator_manufacturing` boolean — Permission representing "Manufacturing Operator" - `default_for_seat_types` S12CommonSubscriptionSeatTypes[] — The seat types that this permission set is the default for. - `permissions_denylist` S12PermissionsV1Permissions — Permissions represents a set of permissions. Individual permissions can be omitted to leave them unchanged. - `manage_role` boolean — Permission representing "Admin" - `billing` boolean — Permission representing "Billing management" - `manage_folders` boolean — Permission representing "Site management" - `create_children` boolean — Permission representing "Group management" - `manage_users` boolean — Permission representing "User management" - `allow_modify_manage_data` boolean — Permission representing "Data management" - `manage_data` boolean — Permission representing "Data access" - `allow_mobile_data_access_sync` boolean — Permission representing "Mobile data access" - `create_template` boolean — Permission representing "Template creation" - `manage_response_sets` boolean — Permission representing "Manage response sets" - `share_public_library` boolean — Permission representing "Upload to Public Library" - `manage_report_preferences` boolean — Permission representing "Manage global report layouts" - `create_schedules` boolean — Permission representing "Schedule creation" - `manage_schedules` boolean — Permission representing "Schedule management" - `manage_incidents` boolean — Permission representing "Issues management" - `incident_access` boolean — Permission representing "Issues access" - `manage_sensors` boolean — Permission representing "Sensor management" - `view_sensors` boolean — Permission representing "Sensors access" - `create_heads_up` boolean — Permission representing "Create Heads up" - `manage_assets` boolean — Permission representing "Assets management" - `view_assets` boolean — Permission representing "Assets access" - `view_training` boolean — Permission representing "Training access" - `manage_tasks` boolean — Permission representing "Manage tasks" - `new_report_experience` boolean — Permission representing "New report experience" Should not be used in new cases. Returned only for backwards compat. - `manage_training` boolean — Permission representing "Training management" - `create_training` boolean — Permission representing "Training creation" - `manage_permissions` boolean — Permission representing "Permission management" - `view_analytics` boolean — Permission representing "Analytics access" - `create_analytics` boolean — Permission representing "Analytics report creation (creator-based)" - `create_site_analytics` boolean — Permission representing "Analytics report creation (site-based)" - `manage_analytics` boolean — Permission representing "Analytics management" - `settings_assets` boolean — Permission representing "Assets settings" - `manage_credentials` boolean — Permission representing "Credentials" - `create_course` boolean — Permission representing "Course creation" - `admin_resources` boolean — Permission representing "Resources Administration" - `manage_training_teams` boolean — Permission representing "Manage Teams" - `manage_companies` boolean — Permission representing "Manage Companies" - `manage_assets_media` boolean — Permission representing "Manage Assets media" - `manage_assets_maintenance` boolean — Permission representing "Manage Assets maintenance" - `settings_lone_worker` boolean — Permission representing "Lone worker settings" - `manage_lone_worker` boolean — Permission representing "Manage Lone Workers" - `access_lone_worker` boolean — Permission representing "Access Lone Workers" - `access_investigations` boolean — Permission representing "Create Investigations" - `manage_investigations` boolean — Permission representing "Manage Investigations" - `manage_heads_up` boolean — Permission representing "Manage Heads Up" - `configuration_investigations` boolean — Permission representing "Configuration Investigations" - `view_investigations` boolean — Permission representing "Read Investigations" - `access_osha` boolean — Permission representing "Access OSHA" - `view_inductions` boolean — Permission representing "Access Onboarding" - `access_ai_assistant` boolean — Permission representing "Access AI Assistant" - `manage_fields` boolean — Permission representing "Manage Fields" - `manage_content_library_publish` boolean — Permission representing "Content Library Publish" - `admin_manufacturing` boolean — Permission representing "Manufacturing Admin" - `operator_manufacturing` boolean — Permission representing "Manufacturing Operator" - `supports_email_less` boolean — Whether the permission set is applicable to users without an email-based username. Derived from `permissions` and the non-email username denylist; mirrors PermissionSetIdentifier.supports_email_less for callers consuming the full PermissionSet. Server-computed; ignored on writes. - `users` string[] — A subset of the users assigned to the permission set. - `user_count` integer — The number of users assigned to the permission set. - `total_results` integer — The total number of results for the provided input. ## 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)