List Users

Get all ACS users

Returns a list of all ACS users.

/acs/users/list

post

Returns a list of all access system users.

Authorizations

client_sessionpat_with_workspaceconsole_session_with_workspaceapi_key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

user_identity_idstring · uuidOptional

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

user_identity_phone_numberstringOptional

Phone number of the user identity for which you want to retrieve all access system users, in E.164 format (for example, [phone]).

user_identity_email_addressstringOptional

Email address of the user identity for which you want to retrieve all access system users.

acs_system_idstring · uuidOptional

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

searchstring · min: 1Optional

String for which to search. Filters returned access system users to include all records that satisfy a partial match using full_name, phone_number, email_address, acs_user_id, user_identity_id, user_identity_full_name or user_identity_phone_number.

limitintegerOptional

Maximum number of records to return per page.

Default: 500

created_beforestring · date-timeOptional

Timestamp by which to limit returned access system users. Returns users created before this timestamp.

page_cursorstring | nullableOptional

Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

Responses

200

OK

application/json

400

Bad Request

401

Unauthorized

post

/acs/users/list

HTTPcURLJavaScriptPython

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

{
  "user_identity_id": "123e4567-e89b-12d3-a456-426614174000",
  "user_identity_phone_number": "text",
  "user_identity_email_address": "text",
  "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
  "search": "text",
  "limit": 500,
  "created_before": "2025-12-16T20:55:54.156Z",
  "page_cursor": "text"
}

{
  "acs_users": [
    {
      "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
      "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
      "hid_acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-12-16T20:55:54.156Z",
      "display_name": "text",
      "external_type": "pti_user",
      "external_type_display_name": "text",
      "is_suspended": true,
      "access_schedule": {
        "starts_at": "2025-12-16T20:55:54.156Z",
        "ends_at": "2025-12-16T20:55:54.156Z"
      },
      "user_identity_id": "text",
      "user_identity_full_name": "text",
      "user_identity_email_address": "text",
      "user_identity_phone_number": "text",
      "warnings": [
        {
          "created_at": "2025-12-16T20:55:54.156Z",
          "message": "text",
          "warning_code": "being_deleted"
        }
      ],
      "errors": [
        {
          "created_at": "2025-12-16T20:55:54.156Z",
          "message": "text",
          "error_code": "deleted_externally"
        }
      ],
      "pending_mutations": [
        {
          "created_at": "2025-12-16T20:55:54.156Z",
          "message": "text",
          "mutation_code": "creating"
        }
      ],
      "last_successful_sync_at": "2025-12-16T20:55:54.156Z",
      "connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
      "salto_space_metadata": {
        "user_id": "text",
        "audit_openings": true
      },
      "full_name": "text",
      "email_address": "[email protected]",
      "phone_number": "text",
      "is_managed": true
    }
  ],
  "pagination": {
    "next_page_cursor": "text",
    "has_next_page": true,
    "next_page_url": "https://example.com"
  },
  "ok": true
}

Request

To filter the list of returned ACS users by a specific access control system, user identity, user identity phone number, or user identity email address, include one or more of the acs_system_id, user_identity_id, user_identity_phone_number, or user_identity_email_address parameters, respectively, in the request body. If you omit these parameters, the response includes all ACS users in your workspace.

Request Body Parameters

Parameter	Type	Description
user_identity_id	String (UUID) Optional	ID of the user identity for which you want to retrieve all ACS users
user_identity_phone_number	String Optional	Phone number of the user identity for which you want to retrieve all ACS users, in E.164 format (for example, [phone])
user_identity_email_address	String Optional	Email address of the user identity for which you want to retrieve all ACS users
acs_system_id	String (UUID) Optional	ID of the access control system for which you want to retrieve all ACS users

Sample Request

Python

seam.acs.users.list(
  user_identity_id="22222222-2222-2222-2222-222222222222",
  user_identity_phone_number="[phone]",
  user_identity_email_address="[email protected]",
  acs_system_id="11111111-1111-1111-1111-111111111111"
)

cURL (bash)

JavaScript

Ruby

PHP

C#

Java

Go

Response

Returns an acs_users array, in which each returned acs_user contains the following properties:

Property	Description
acs_user_id	ID of the ACS user
display_name	Display name for the ACS user
full_name	Full name of the ACS user
email	Email address of the ACS user (for backward compatibility)
email_address	Email address of the ACS user
phone_number	Phone number of the ACS user in E.164 format (for example, [phone])
acs_system_id	ID of the access control system that contains the ACS user
workspace_id	ID of the workspace that contains the ACS user
created_at	Date and time at which the ACS user was created
is_suspended	Indicates whether the ACS user is currently suspended
access_schedule	starts_at and ends_at dates/times for the ACS user's access
user_identity_id	ID of the user identity associated with the ACS user
user_identity_full_name	Full name of the user identity associated with the ACS user
user_identity_email_address	Email address of the user identity associated with the ACS user
user_identity_phone_number	Phone number of the user identity associated with the ACS user in E.164 format (for example, [phone])

Sample Response

Python

[
  AcsUser(
    acs_user_id="33333333-3333-3333-3333-333333333333',
    display_name='Jane Doe',
    full_name='Jane Doe',
    email='[email protected]',
    email_address='[email protected]',
    phone_number='[phone]',
    acs_system_id='11111111-1111-1111-1111-111111111111',
    workspace_id='00000000-0000-0000-0000-000000000000",
    created_at='2024-04-05T07:14:28.531Z',
    is_suspended=False,
    access_schedule={
      'starts_at': '2024-03-01T10:40:00.000Z',
      'ends_at': '2024-03-04T10:40:00.000Z'
    },
    user_identity_id='22222222-2222-2222-2222-222222222222',
    user_identity_full_name='Jane Doe',
    user_identity_email_address='[email protected]',
    user_identity_phone_number='[phone]'
  ),
  ...
]

cURL (bash)

JavaScript

Ruby

PHP

C#

Java

Go