GET User

Returns detailed information for a specific user.

Overview

This endpoint retrieves comprehensive information about a specific user within a customer's system. This is useful for getting complete user details after identifying a user from the list endpoint.

Resource URL

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

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
UserGuid	String	Yes	The unique identifier for the user

Example URL

https://api.volo-access.com/v1/business/customer/550e8400-e29b-41d4-a716-446655440000/user/123e4567-e89b-12d3-a456-426614174000

Response

Success Response (200 OK)

Returns a CustomerUsersDetailsResponse object with detailed user information:

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

{
  "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 including special access requirements",
  "largeCustomField2": "Emergency contact: Jane Doe (555-0123)",
  "extraLargeCustomField": "Detailed user profile information including training records, certifications, and special permissions",
  "isExemptFromLockDown": false,
  "accessLevelGuid": "789e0123-e89b-12d3-a456-426614174002",
  "accessLevelDescription": "Standard Access",
  "userGroupGuid": "012e3456-e89b-12d3-a456-426614174003",
  "userGroupDescription": "Employees",
  "accessLevelId": 1,
  "userId": 1001
}

Error Responses

400 Bad Request

Returned for invalid GUID format:

{
  "applicationMessage": "Invalid GUID format provided",
  "consumerMessage": "The user or 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 user details:

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

404 Not Found

Returned when the customer or user doesn't exist:

{
  "applicationMessage": "User with GUID 123e4567-e89b-12d3-a456-426614174000 not found",
  "consumerMessage": "User 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/123e4567-e89b-12d3-a456-426614174000
x-nonce-token: MDU4ZmQ5Y2EtNTExNi00N2E0LWI0Y2EtNjM1YWRjZTZjYmNi
x-app-token: d1d0ecac-3cca-48ef-a4c3-83005c6376ca
x-user-credential: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Usage Notes

• GUID Format: Both customer and user GUIDs follow the standard UUID format
• Permissions: Users can only access data they have permission to view
• Performance: This endpoint is optimized for quick retrieval of individual user data
• Null Values: Many fields may be null if not configured for the user
• Date Formats: All dates are returned in ISO 8601 format
• Custom Fields: The system supports various custom fields for additional user information
• Access Levels: Check the access level information to understand user permissions
• Bar Status: The isBarred field indicates if the user has restricted access

Related Endpoints

• List Customer Users - Get all users for a customer
• List Customer Events - Get events for this customer