> ## Documentation Index
> Fetch the complete documentation index at: https://docs.seam.co/llms.txt
> Use this file to discover all available pages before exploring further.

# The Access Group Object

> Learn how the acs_access_group object defines the entrances a set of access system users can reach and, in some systems, their access schedule.

## The acs\_access\_group Object

Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.

Some access control systems use [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.

To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/device-and-system-integration-guides#access-control-systems).

<ResponseExample>
  ```json ACS Access Group theme={null}
  {
    "access_group_type": "salto_ks_access_group",
    "access_group_type_display_name": "Salto KS Access Group",
    "acs_access_group_id": "3f448826-9875-4947-9519-e468090a4f7d",
    "acs_system_id": "045baa77-6d06-40fe-a2cd-b82eef688f4a",
    "connected_account_id": "daba7bd0-edb6-4bb9-a70b-f9ae08a0e301",
    "created_at": "2025-06-15T16:54:17.946453Z",
    "display_name": "Main Group",
    "errors": [],
    "external_type": "salto_ks_access_group",
    "external_type_display_name": "Salto KS Access Group",
    "is_managed": true,
    "name": "My Access Group",
    "pending_mutations": [],
    "warnings": [],
    "workspace_id": "ac19352c-869a-4209-9ce7-44c740a8b5d0"
  }
  ```
</ResponseExample>

***

## Properties

<ResponseField name="access_group_type" type="Enum (String)" deprecated>
  The access group type.
</ResponseField>

<ResponseField name="access_group_type_display_name" type="String" deprecated>
  The access group type display name.
</ResponseField>

<ResponseField name="access_schedule" type="Object">
  `starts_at` and `ends_at` timestamps for the access group's access.

  <Expandable title="properties">
    <ResponseField name="ends_at" type="String (ISO 8601)">
      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.
    </ResponseField>

    <ResponseField name="starts_at" type="String (ISO 8601)">
      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.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="acs_access_group_id" type="String (UUID)">
  ID of the access group.
</ResponseField>

<ResponseField name="acs_system_id" type="String (UUID)">
  ID of the access control system that contains the access group.
</ResponseField>

<ResponseField name="connected_account_id" type="String (UUID)">
  ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the access group.
</ResponseField>

<ResponseField name="created_at" type="String (ISO 8601)">
  Date and time at which the access group was created.
</ResponseField>

<ResponseField name="display_name" type="String">
  The display name.
</ResponseField>

<ResponseField name="errors" type="Array">
  Errors associated with the `acs_access_group`.
</ResponseField>

<ResponseField name="external_type" type="Enum (String)">
  Brand-specific terminology for the access group type.
</ResponseField>

<ResponseField name="external_type_display_name" type="String">
  Display name that corresponds to the brand-specific terminology for the access group type.
</ResponseField>

<ResponseField name="is_managed" type="Boolean">
  The is managed.
</ResponseField>

<ResponseField name="name" type="String">
  Name of the access group.
</ResponseField>

<ResponseField name="pending_mutations" type="Array">
  Collection of pending mutations for the access group. Represents operations that have been requested but not yet completed on the integrated access system.
</ResponseField>

<ResponseField name="warnings" type="Array">
  Warnings associated with the `acs_access_group`.
</ResponseField>

<ResponseField name="workspace_id" type="String (UUID)">
  ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the access group.
</ResponseField>
