List Users
Get all ACS users
Returns a list of all ACS users.
Returns a list of all access system users.
ID of the user identity for which you want to retrieve all access system users.
Phone number of the user identity for which you want to retrieve all access system users, in E.164 format (for example, +15555550100).
Email address of the user identity for which you want to retrieve all access system users.
ID of the acs_system for which you want to retrieve all access system users.
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.
Maximum number of records to return per page.
500Timestamp by which to limit returned access system users. Returns users created before this timestamp.
Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.
POST /acs/users/list HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer Client Session 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-07-01T05:01:42.246Z",
"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-07-01T05:01:42.246Z",
"display_name": "text",
"external_type": "pti_user",
"external_type_display_name": "text",
"is_suspended": true,
"access_schedule": {
"starts_at": "2025-07-01T05:01:42.246Z",
"ends_at": "2025-07-01T05:01:42.246Z"
},
"user_identity_id": "text",
"user_identity_full_name": "text",
"user_identity_email_address": "text",
"user_identity_phone_number": "text",
"warnings": [
{
"created_at": "2025-07-01T05:01:42.246Z",
"message": "text",
"warning_code": "being_deleted"
}
],
"errors": [
{
"created_at": "2025-07-01T05:01:42.246Z",
"message": "text",
"error_code": "deleted_externally"
}
],
"pending_mutations": [
{
"created_at": "2025-07-01T05:01:42.246Z",
"message": "text",
"mutation_code": "creating"
}
],
"last_successful_sync_at": "2025-07-01T05:01:42.246Z",
"connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
"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
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, +15555550100)
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
seam.acs.users.list(
user_identity_id="22222222-2222-2222-2222-222222222222",
user_identity_phone_number="+15555550100",
user_identity_email_address="[email protected]",
acs_system_id="11111111-1111-1111-1111-111111111111"
)Response
Returns an acs_users array, in which each returned acs_user contains the following properties:
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, +15555550100)
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, +15555550100)
Sample Response
[
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='+15555550100',
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='+15555550100'
),
...
]Last updated
Was this helpful?