Get an Access Group

Get a specified access group

Returns a specified access group.

/acs/access_groups/get

post

Returns a specified access group.

Authorizations
Body
acs_access_group_idstring · uuidRequired

ID of the access group that you want to get.

Responses
200
OK
application/json
post
POST /acs/access_groups/get HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer API Token
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "acs_access_group_id": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "acs_access_group": {
    "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-07-01T04:11:26.012Z",
    "warnings": [
      {
        "created_at": "2025-07-01T04:11:26.012Z",
        "message": "text",
        "warning_code": "unknown_issue_with_acs_access_group"
      }
    ],
    "is_managed": true
  },
  "ok": true
}

Request

Specify the desired access group by including the corresponding acs_access_group_id in the request body.

Request Body Parameters

Parameter
Type
Description

acs_access_group_id

String (UUID) Required

ID of the desired access group

Sample Request

seam.acs.access_groups.get(
  acs_access_group_id="44444444-4444-4444-4444-444444444444"
)

Response

Returns an acs_access_group containing 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'
)

Last updated

Was this helpful?

Revision created

Merge branch 'main' into beta