List ACS Users

• Request Parameters

• Response

• Examples

Returns a list of all access system users.

Signature

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

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, [phone]).

---

Response

Array of acs_users

JSON

{
  JSON representation of acs_user
}

---

Examples

List all ACS users

Returns a list of all ACS users.

JavaScript

Code

await seam.acs.users.list();

Output

{
  "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": "[e-mail]",
  "phone_number": "[phone]"
}

Python

Code

seam.acs.users.list()

Output

AcsUser(
    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="[e-mail]",
    phone_number="[phone]",
)

Ruby

Code

seam.acs.users.list()

Output

{
  "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" => "[e-mail]",
  "phone_number" => "[phone]",
}

PHP

Code

<?php
$seam->acs->users->list();

Output

<?php
[
    "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" => "[e-mail]",
    "phone_number" => "[phone]",
];

Seam CLI

Code

seam acs users list

Output

{
  "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": "[e-mail]",
  "phone_number": "[phone]"
}

Go

Code

package main

func main() {
	client.Acs.Users.List(context.Background())
}

Output

api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "[e-mail]", PhoneNumber: "[phone]"}

cURL

Code

curl --include --request POST "https://connect.getseam.com/acs/users/list" \
  --header "Authorization: Bearer $SEAM_API_KEY"

Output

{
  "acs_users": {
    "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": "[e-mail]",
    "phone_number": "[phone]"
  }
}