--- title: "List Access Groups" method: POST path: "/acs/access_groups/list" tags: ["/acs"] --- # List Access Groups `POST /acs/access_groups/list` Returns a list of all [access groups](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). ## Request body - object - `acs_system_id` string, uuid — ID of the access system for which you want to retrieve all access groups. - `acs_user_id` string, uuid — ID of the access system user for which you want to retrieve all access groups. - `search` string — String for which to search. Filters returned access groups to include all records that satisfy a partial match using `name` or `acs_access_group_id`. - `user_identity_id` string, uuid — ID of the user identity for which you want to retrieve all access groups. ## Response `200` OK - object - `acs_access_groups` AcsAccessGroup[], required - `access_group_type` 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group' | 'avigilon_alta_group' | 'kisi_access_group', required — Deprecated. Use `external_type`. - `access_group_type_display_name` string, required — Deprecated. Use `external_type_display_name`. - `access_schedule` object — `starts_at` and `ends_at` timestamps for the access group's access. - `ends_at` string, date-time, nullable, required — Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - `starts_at` string, date-time, required — Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - `acs_access_group_id` string, uuid, required — ID of the access group. - `acs_system_id` string, uuid, required — ID of the access control system that contains the access group. - `connected_account_id` string, uuid, required — ID of the connected account that contains the access group. - `created_at` string, date-time, required — Date and time at which the access group was created. - `display_name` string, required — Display name for the access group. - `errors` object[], required — Errors associated with the `acs_access_group`. - `created_at` string, date-time, required — Date and time at which Seam created the error. - `error_code` 'failed_to_create_on_acs_system', required — Unique identifier of the type of error. Enables quick recognition and categorization of the issue. - `message` string, required — Detailed description of the error. Provides insights into the issue and potentially how to rectify it. - `external_type` 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group' | 'avigilon_alta_group' | 'kisi_access_group', required — Brand-specific terminology for the access group type. - `external_type_display_name` string, required — Display name that corresponds to the brand-specific terminology for the access group type. - `is_managed` true, required — Indicates whether Seam manages the access group. - `name` string, required — Name of the access group. - `pending_mutations` union[], required — Collection of pending mutations for the access group. Represents operations that have been requested but not yet completed on the integrated access system. - union - object — Seam is in the process of pushing an access group creation to the integrated access system. - `created_at` string, date-time, required — Date and time at which the mutation was created. - `message` string, required — Detailed description of the mutation. - `mutation_code` 'creating', required — Mutation code to indicate that Seam is in the process of pushing an access group creation to the integrated access system. - object — Seam is in the process of pushing an access group deletion to the integrated access system. - `created_at` string, date-time, required — Date and time at which the mutation was created. - `message` string, required — Detailed description of the mutation. - `mutation_code` 'deleting', required — Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system. - object — This access group is scheduled for automatic deletion when its access window expires. - `created_at` string, date-time, required — Date and time at which the mutation was created. - `message` string, required — Detailed description of the mutation. - `mutation_code` 'deferring_deletion', required — Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires. - object — Seam is in the process of pushing an access group information update to the integrated access system. - `created_at` string, date-time, required — Date and time at which the mutation was created. - `from` object, required — Old access group information. - `name` string, nullable — Name of the access group. - `message` string, required — Detailed description of the mutation. - `mutation_code` 'updating_group_information', required — Mutation code to indicate that Seam is in the process of pushing updated access group information to the integrated access system. - `to` object, required — New access group information. - `name` string, nullable — Name of the access group. - object — Seam is in the process of pushing an access schedule update to the integrated access system. - `created_at` string, date-time, required — Date and time at which the mutation was created. - `from` object, required — Old access schedule information. - `ends_at` string, date-time, nullable, required — Ending time for the access schedule. - `starts_at` string, date-time, nullable, required — Starting time for the access schedule. - `message` string, required — Detailed description of the mutation. - `mutation_code` 'updating_access_schedule', required — Mutation code to indicate that Seam is in the process of pushing updated access schedule information to the integrated access system. - `to` object, required — New access schedule information. - `ends_at` string, date-time, nullable, required — Ending time for the access schedule. - `starts_at` string, date-time, nullable, required — Starting time for the access schedule. - object — Seam is in the process of pushing a user membership update to the integrated access system. - `created_at` string, date-time, required — Date and time at which the mutation was created. - `from` object, required — Old user membership. - `acs_user_id` string, uuid, nullable, required — Old user ID. - `message` string, required — Detailed description of the mutation. - `mutation_code` 'updating_user_membership', required — Mutation code to indicate that Seam is in the process of pushing updated user membership information to the integrated access system. - `to` object, required — New user membership. - `acs_user_id` string, uuid, nullable, required — New user ID. - object — Seam is in the process of pushing an entrance membership update to the integrated access system. - `created_at` string, date-time, required — Date and time at which the mutation was created. - `from` object, required — Old entrance membership. - `acs_entrance_id` string, uuid, nullable, required — Old entrance ID. - `message` string, required — Detailed description of the mutation. - `mutation_code` 'updating_entrance_membership', required — Mutation code to indicate that Seam is in the process of pushing updated entrance membership information to the integrated access system. - `to` object, required — New entrance membership. - `acs_entrance_id` string, uuid, nullable, required — New entrance ID. - object — A scheduled user membership change is pending for this access group. - `acs_user_id` string, uuid, required — ID of the user involved in the scheduled change. - `created_at` string, date-time, required — Date and time at which the mutation was created. - `message` string, required — Detailed description of the mutation. - `mutation_code` 'deferring_user_membership_update', required — Mutation code to indicate that a scheduled user membership change is pending for this access group. - `variant` 'adding' | 'removing', required — Whether the user is scheduled to be added to or removed from this access group. - `warnings` union[], required — Warnings associated with the `acs_access_group`. - union — Warning associated with the `acs_access_group`. - object — An unknown issue occurred while syncing the state of this access group with the provider. This issue may affect the proper functioning of this access group. - `created_at` string, date-time, required — Date and time at which Seam created the warning. - `message` string, required — Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. - `warning_code` 'unknown_issue_with_acs_access_group', required — Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. - object — Indicates that the access group is being deleted from the access system. This is a temporary state, and the access group will be deleted shortly. - `created_at` string, date-time, required — Date and time at which Seam created the warning. - `message` string, required — Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. - `warning_code` 'being_deleted', required — Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. - `workspace_id` string, uuid, required — ID of the workspace that contains the access group. ## Other responses - `400` — Bad Request - `401` — Unauthorized --- [API](https://skmtc.net/seam/apis/seam-connect.md) · [All operations](https://skmtc.net/seam/apis/seam-connect/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/seam/seam-connect/versions/00c35395ce12/schema)