List ACS Users

POST /acs/users/list ⇒ { acs_users: [acs_user, …] }

Returns a list of all ACS users.

JavaScript

Request

await seam.acs.users.list();

Response

{
  "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
  "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2024-04-05T07:57:05.323Z",
  "display_name": "Jane Doe",
  "full_name": "Jane Doe",
  "email_address": "[email protected]",
  "phone_number": "[phone]"
}

Python

Ruby

PHP

Seam CLI

Go

Authentication Methods

• API key

• Client session token

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

Request Parameters

acs_system_id

Type: string Required: No

ID of the acs_system for which you want to retrieve all acs_users.

---

created_before

Type: string Required: No

---

limit

Type: number Required: No

Maximum number of records to return per page.

---

page_cursor

Type: string Required: No

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

---

search

Type: string Required: No

String for which to search. Filters returned acs_users to include all records that satisfy a partial match using full_name, phone_number, or email_address.

---

user_identity_email_address

Type: string Required: No

Email address of the user identity for which you want to retrieve all acs_users.

---

user_identity_id

Type: string Required: No

ID of the user identity for which you want to retrieve all acs_users.

---

user_identity_phone_number

Type: string Required: No

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

---

Return Type

Array<acs_user>