Skip to main content

GET Customer

Returns the details of a single customer by unique GUID.

Overview​

This endpoint retrieves detailed information about a specific customer using their unique GUID identifier. This is useful for getting complete customer information after identifying a customer from the list endpoint.

Resource URL​

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

Authentication​

This endpoint requires both application and user authentication:

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

Path Parameters​

ParameterTypeRequiredDescription
CustomerGuidStringYesThe unique identifier (GUID) for the customer

Example URL​

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

Response​

Success Response (200 OK)​

Returns a CustomerDetailsResponse object with customer information:

ParameterTypeDescription
customerCodeStringUnique customer code
customerNameStringCustomer name
notesStringAdditional notes about the customer
geographicTimezoneIdStringTimezone identifier for the customer
customerIdIntegerInternal customer ID

Example Success Response​

{
  "customerCode": "CUST001",
  "customerName": "Acme Corporation",
  "notes": "Main office building with multiple floors and secure areas",
  "geographicTimezoneId": "Europe/London",
  "customerId": 12345
}

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:

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

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 customer data"
}

Example Request​

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

Usage Notes​

  • GUID Format: Customer GUIDs follow the standard UUID format (e.g., 550e8400-e29b-41d4-a716-446655440000)
  • Permissions: Users can only access customers they have permission to view
  • Performance: This endpoint is optimized for quick retrieval of individual customer data
  • Caching: Consider caching customer details for frequently accessed customers
  • Null Values: Some fields like notes may be null if no data is available