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

/*
[
  {
    "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": "jane@example.com",
    "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": "jane@example.com",
    "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"
  }
]
*/
{
  "acs_users": [
    {
      "acs_system_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "acs_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "display_name": "<string>",
      "errors": [
        {
          "error_code": "<string>",
          "message": "<string>",
          "created_at": "2023-11-07T05:31:56Z"
        }
      ],
      "last_successful_sync_at": "2023-11-07T05:31:56Z",
      "warnings": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "message": "<string>"
        }
      ],
      "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "access_schedule": {
        "ends_at": "2023-11-07T05:31:56Z",
        "starts_at": "2023-11-07T05:31:56Z"
      },
      "email": "jsmith@example.com",
      "email_address": "jsmith@example.com",
      "external_type_display_name": "<string>",
      "full_name": "<string>",
      "hid_acs_system_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_suspended": true,
      "pending_mutations": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "message": "<string>"
        }
      ],
      "phone_number": "<string>",
      "salto_space_metadata": {
        "audit_openings": true,
        "user_id": "<string>"
      },
      "user_identity_email_address": "<string>",
      "user_identity_full_name": "<string>",
      "user_identity_id": "<string>",
      "user_identity_phone_number": "<string>"
    }
  ],
  "ok": true,
  "pagination": {
    "has_next_page": true,
    "next_page_cursor": "<string>",
    "next_page_url": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
acs_system_id
string<uuid>

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

​
created_before
string<date-time>

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

​
limit
integer
default:500

Maximum number of records to return per page.

Required range: x > 0
​
page_cursor
string | null

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.

Minimum string length: 1
​
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<uuid>

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

OK

​
acs_users
object[]
required
​
ok
boolean
required
​
pagination
object
required

Information about the current page of results.