GET Customer Users

Returns a list of all users associated with the specified customer.

Overview

This endpoint retrieves all users that belong to a specific customer. This is essential for user management operations and understanding the access control structure for a customer.

Resource URL

https://api.volo-access.com/v1/business/customer/{CustomerGuid}/user

Authentication

This endpoint requires both application and user authentication:

• x-nonce-token: Required
• x-app-token: Required
• x-user-credential: Required

Path Parameters

Parameter	Type	Required	Description
CustomerGuid	String	Yes	The unique identifier for the customer

Example URL

https://api.volo-access.com/v1/business/customer/550e8400-e29b-41d4-a716-446655440000/user

Response

Success Response (200 OK)

Returns a ListCustomerUsersDetailsResponse object containing an array of users:

Parameter	Type	Description
customerUsersDetailsResponseList	Array	Array of user objects

Each user object contains:

Parameter	Type	Description
userGuid	String	The user GUID (primary key)
firstName	String	The user first name
lastName	String	The user last name
dateValidFrom	DateTime	The date valid from (ISO 8601 format)
expiryDate	DateTime	The expiry date (ISO 8601 format)
pin	Integer	The pin code
verificationPin	Integer	The verification pin
pinTokenGuid	String	The token GUID
isBarred	Boolean	Whether the user is barred
smallCustomField1	String	The small custom field 1
smallCustomField2	String	The small custom field 2
largeCustomField1	String	The large custom field 1
largeCustomField2	String	The large custom field 2
extraLargeCustomField	String	The extra large custom field
isExemptFromLockDown	Boolean	Whether the user is exempt from lock down
accessLevelGuid	String	The access level unique identifier
accessLevelDescription	String	The access level description
userGroupGuid	String	The user group unique identifier
userGroupDescription	String	The user group description
accessLevelId	Integer	The access level ID
userId	Integer	The user ID

Example Success Response

{
  "customerUsersDetailsResponseList": [
    {
      "userGuid": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "John",
      "lastName": "Doe",
      "dateValidFrom": "2024-01-01T00:00:00.000Z",
      "expiryDate": "2024-12-31T23:59:59.000Z",
      "pin": 1234,
      "verificationPin": 5678,
      "pinTokenGuid": "456e7890-e89b-12d3-a456-426614174001",
      "isBarred": false,
      "smallCustomField1": "Employee ID: EMP001",
      "smallCustomField2": "Department: IT",
      "largeCustomField1": "Additional notes about the user",
      "largeCustomField2": null,
      "extraLargeCustomField": null,
      "isExemptFromLockDown": false,
      "accessLevelGuid": "789e0123-e89b-12d3-a456-426614174002",
      "accessLevelDescription": "Standard Access",
      "userGroupGuid": "012e3456-e89b-12d3-a456-426614174003",
      "userGroupDescription": "Employees",
      "accessLevelId": 1,
      "userId": 1001
    },
    {
      "userGuid": "234e5678-e89b-12d3-a456-426614174004",
      "firstName": "Jane",
      "lastName": "Smith",
      "dateValidFrom": "2024-01-15T00:00:00.000Z",
      "expiryDate": "2024-12-31T23:59:59.000Z",
      "pin": 5678,
      "verificationPin": 9012,
      "pinTokenGuid": "567e8901-e89b-12d3-a456-426614174005",
      "isBarred": false,
      "smallCustomField1": "Employee ID: EMP002",
      "smallCustomField2": "Department: HR",
      "largeCustomField1": null,
      "largeCustomField2": null,
      "extraLargeCustomField": null,
      "isExemptFromLockDown": true,
      "accessLevelGuid": "890e1234-e89b-12d3-a456-426614174006",
      "accessLevelDescription": "Admin Access",
      "userGroupGuid": "123e4567-e89b-12d3-a456-426614174007",
      "userGroupDescription": "Administrators",
      "accessLevelId": 2,
      "userId": 1002
    }
  ]
}

Error Responses

400 Bad Request

Returned for invalid customer GUID format:

{
  "applicationMessage": "Invalid GUID format provided",
  "consumerMessage": "The customer identifier format is invalid"
}

401 Unauthorized

Returned when authentication is missing or invalid:

{
  "applicationMessage": "Missing or invalid authentication headers",
  "consumerMessage": "Authentication required"
}

403 Forbidden

Returned when user lacks permission to view the customer's users:

{
  "applicationMessage": "User does not have permission to access customer user data",
  "consumerMessage": "You do not have permission to view this information"
}

404 Not Found

Returned when the customer doesn't exist:

{
  "applicationMessage": "Customer with GUID 550e8400-e29b-41d4-a716-446655440000 not found",
  "consumerMessage": "Customer not found"
}

500 Internal Server Error

Returned for server-side errors:

{
  "applicationMessage": "Database connection failed",
  "consumerMessage": "An error occurred while retrieving user data"
}

Example Request

GET https://api.volo-access.com/v1/business/customer/550e8400-e29b-41d4-a716-446655440000/user
x-nonce-token: MDU4ZmQ5Y2EtNTExNi00N2E0LWI0Y2EtNjM1YWRjZTZjYmNi
x-app-token: d1d0ecac-3cca-48ef-a4c3-83005c6376ca
x-user-credential: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Usage Notes

• Large Datasets: For customers with many users, this endpoint may return a large amount of data
• Pagination: Consider implementing client-side pagination for better performance
• Permissions: Users can only access customer data they have permission to view
• Null Values: Many fields may be null if not configured for the user
• Date Formats: All dates are returned in ISO 8601 format
• Barred Users: Check the isBarred field to identify users with restricted access
• Custom Fields: The system supports various custom fields for additional user information

Related Endpoints

• Get User Details - Get detailed information about a specific user
• List Customer Events - Get events for this customer