Sign UpSupported Devices
Edit

List Access Groups

Get all access groups

Returns a list of all access groups.

/acs/access_groups/list

post

Returns a list of all access groups.

Authorizations
Body
acs_system_idstring · uuidOptional

ID of the access system for which you want to retrieve all access groups.

acs_user_idstring · uuidOptional

ID of the access system user for which you want to retrieve all access groups.

user_identity_idstring · uuidOptional

ID of the user identity for which you want to retrieve all access groups.

Responses
200

OK

application/json
post
/acs/access_groups/list
POST /acs/access_groups/list HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 167

{
  "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
  "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
  "user_identity_id": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "acs_access_groups": [
    {
      "acs_access_group_id": "123e4567-e89b-12d3-a456-426614174000",
      "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "display_name": "text",
      "external_type": "pti_unit",
      "external_type_display_name": "text",
      "created_at": "2025-11-03T14:08:20.750Z",
      "warnings": [
        {
          "created_at": "2025-11-03T14:08:20.750Z",
          "message": "text",
          "warning_code": "unknown_issue_with_acs_access_group"
        }
      ],
      "is_managed": true
    }
  ],
  "ok": true
}

Request

To filter the list of returned access groups by a specific access control system or ACS user, include one or both of the acs_system_id or acs_user_id parameters, respectively, in the request body. If you omit these parameters, the response includes all access groups in your workspace.

Request Body Parameters

Parameter
Type
Description

acs_system_id

String (UUID) Optional

ID of the access control system for which you want to retrieve all access groups

acs_user_id

String (UUID) Optional

ID of the user for which you want to retrieve all access groups

Sample Request

seam.acs.access_groups.list(
  acs_system_id="11111111-1111-1111-1111-111111111111",
  acs_user_id="33333333-3333-3333-3333-333333333333"
)

Response

Returns an acs_access_groups array, in which each returned acs_access_group contains the following properties:

Property
Description

acs_access_group_id

ID of the access group

name

Name of the access group

display_name

Display name for the access group

external_type

Brand-specific terminology for the access group type

external_type_display_name

Display name that corresponds to the brand-specific terminology for the access group type

acs_system_id

ID of the access control system that contains the access group

workspace_id

ID of the workspace that contains the access group

created_at

Date and time at which the access group was created

Sample Response

[
  AcsAccessGroup(
    acs_access_group_id='44444444-4444-4444-4444-444444444444',
    acs_system_id='11111111-1111-1111-1111-111111111111',
    workspace_id='00000000-0000-0000-0000-000000000000',
    name='Lobby Access',
    access_group_type='pti_access_level',
    access_group_type_display_name='PTI access level',
    external_type='pti_access_level',
    external_type_display_name='PTI access level',
    created_at='2023-11-30T06:27:15.437Z'
  ),
  ...
]
PreviousAccess GroupsNextGet an Access Group

Last updated

Was this helpful?