List ACS Users

Returns a list of all access system users.

Returns a list of all access system users for a specified user identity.

Code:

await seam.acs.users.list({
  user_identity_id: "0dcb435f-0aef-4ae6-8d6e-9c605b78c94e",
});

Output:

[
  {
    "access_schedule": {
      "ends_at": "2025-06-12T11:00:00.000Z",
      "starts_at": "2025-06-10T15:00:00.000Z"
    },
    "acs_system_id": "62d3384f-267f-4a4a-a946-d35819ec9981",
    "acs_user_id": "6a5d9697-3cc4-436a-8165-4375ff424870",
    "connected_account_id": "c0175797-30f0-49f7-a228-2df115443ca7",
    "created_at": "2025-06-15T16:54:17.946482Z",
    "display_name": "Jane Doe",
    "email_address": "[email protected]",
    "errors": [],
    "external_type": "salto_site_user",
    "external_type_display_name": "Salto site user",
    "full_name": "Jane Doe",
    "hid_acs_system_id": "2acbe47f-612c-422a-9205-7af292f74e7f",
    "is_managed": true,
    "is_suspended": false,
    "last_successful_sync_at": "2025-06-18T17:45:00.582Z",
    "pending_mutations": [],
    "phone_number": "+1555551000",
    "user_identity_email_address": "[email protected]",
    "user_identity_full_name": "Jane Doe",
    "user_identity_id": "0dcb435f-0aef-4ae6-8d6e-9c605b78c94e",
    "user_identity_phone_number": "+1555551000",
    "warnings": [],
    "workspace_id": "8d4868e3-2f95-4f33-8689-19420b3101cd"
  }
]
Authentication Methods
  • API key

  • Client session token

  • Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

acs_system_id String

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


created_before String

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


limit Number

Maximum number of records to return per page.


page_cursor String

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


search String

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.


user_identity_email_address String

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


user_identity_id String

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


user_identity_phone_number String

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


Response


Examples

List access system users for a user identity phone number

Returns a list of all access system users for a specified user identity phone number.

Code:

Output:


List access system users for a user identity email address

Returns a list of all access system users for a specified user identity email address.

Code:

Output:


List users for an access system

Returns a list of all users for a specified access system.

Code:

Output:


List access system users, filtered by a string

Returns a list of all access system users, filtered by a string.

Code:

Output:


List access system users, limited to ten per page

Returns a list of all access system users, with a limit of ten per page.

Code:

Output:


List access system users created before a date

Returns a list of all access system users created before a specified date.

Code:

Output:

Last updated

Was this helpful?