Get an Access Group

Returns a specified access group.

POST /acs/access_groups/get

JavaScript

Seam SDK

await seam.acs.accessGroups.get({
  acs_access_group_id: "09eb5265-6e3b-4e6d-bf96-736171c547ae",
});

/*
{
  "access_group_type": "salto_ks_access_group",
  "access_group_type_display_name": "Salto KS Access Group",
  "acs_access_group_id": "09eb5265-6e3b-4e6d-bf96-736171c547ae",
  "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",
  "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"
}
*/

200

{
  "acs_access_group": {
    "access_group_type_display_name": "<string>",
    "acs_access_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "acs_system_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "display_name": "<string>",
    "errors": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "message": "<string>"
      }
    ],
    "external_type_display_name": "<string>",
    "name": "<string>",
    "pending_mutations": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "message": "<string>"
      }
    ],
    "warnings": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "message": "<string>"
      }
    ],
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "access_schedule": {
      "ends_at": "2023-11-07T05:31:56Z",
      "starts_at": "2023-11-07T05:31:56Z"
    }
  },
  "ok": true
}

Authorizations

pat_with_workspaceconsole_session_with_workspaceapi_key

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

acs_access_group_id · string<uuid> · required

ID of the access group that you want to get.

Response

200

application/json

OK

acs_access_group · object · required

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.

Show child attributes

ok · boolean · required