Ask or search…
K
Links

List Users

Get all users for a specified access control system
Returns a list of all users (acs_user objects).
post
https://connect.getseam.com
/acs/users/list
/acs/users/list

Request

Specify the access control system for which you want to retrieve all users by including the corresponding acs_system_id in the request body.

Request Body Parameters

Parameter
Type
Description
acs_system_id
String Required
ID of the access control system for which you want to retrieve all users

Sample Request

cURL (bash)
# Use GET or POST.
curl -X 'GET' \
'https://connect.getseam.com/acs/users/list' \
-H 'accept: application/json' \
-H 'Authorization: Bearer ${API_KEY}' \
-H 'Content-Type: application/json' \
-d '{
"acs_system_id": "fc793d86-dcfd-4cfe-859f-0b9c1a5c1360"
}'

Response

Returns an acs_users array, in which each returned user (acs_user) contains the following properties:
Property
Description
acs_user_id
ID of the user
display_name
Display name for the user
full_name
Full name of the user
email_address
Email address of the user
phone_number
Phone number of the user in E.164 format (for example, +15555550100)
external_type
Brand-specific terminology for the user type
external_type_display_name
Display name that corresponds to the brand-specific terminology for the user type
acs_system_id
ID of the access control system that contains the user
workspace_id
ID of the workspace that contains the user
created_at
Date and time at which the user was created
is_suspended
Boolean value to indicate whether the user is currently suspended
This response also includes a Boolean ok status indicator.

Sample Response

JSON
{
"acs_users": [
{
"acs_user_id": "efaeae64-e471-4e1f-a621-f518c624d99c",
"display_name": "Jenny Gergenson",
"full_name": "Jenny Gergenson",
"email_address": "[email protected]",
"phone_number": "+15555550101",
"external_type": "pti_user",
"external_type_display_name": "PTI user",
"acs_system_id": "fc793d86-dcfd-4cfe-859f-0b9c1a5c1360",
"workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
"created_at": "2023-09-28T01:40:51.475Z",
"is_suspended": false
},
{
"acs_user_id": "5c54cab2-784f-400e-b318-7a1bedf2066d",
"display_name": "John Doe",
"full_name": "John Doe",
"email_address": "[email protected]",
"phone_number": "+15555550102",
"external_type": "pti_user",
"external_type_display_name": "PTI user",
"acs_system_id": "fc793d86-dcfd-4cfe-859f-0b9c1a5c1360",
"workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
"created_at": "2023-09-28T01:40:51.135Z",
"is_suspended": false
},
{
"acs_user_id": "12a28234-56c8-4721-951f-b507707522b4",
"display_name": "Gary Smith",
"full_name": "Gary Smith",
"email_address": "[email protected]",
"phone_number": "+15555550103",
"external_type": "pti_user",
"external_type_display_name": "PTI user",
"acs_system_id": "fc793d86-dcfd-4cfe-859f-0b9c1a5c1360",
"workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
"created_at": "2023-09-28T01:40:51.331Z",
"is_suspended": false
}
],
"ok": true
}