Skip to main content

GET Customers

Returns a list of all customers registered in the system under the authenticated user.

Overview​

This endpoint provides access to all customers that the authenticated user has permission to view. It's typically the first endpoint called after authentication to understand what customer data is available.

Resource URL​

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

Authentication​

This endpoint requires both application and user authentication:

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

Request Parameters​

This endpoint does not accept any query parameters.

Response​

Success Response (200 OK)​

Returns a ListCustomerDetailsResponse object containing an array of customers:

ParameterTypeDescription
customerDetailsResponseListArrayArray of customer objects

Each customer object contains:

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

Example Success Response​

{
  "customerDetailsResponseList": [
    {
      "customerCode": "CUST001",
      "customerName": "Acme Corporation",
      "notes": "Main office building",
      "geographicTimezoneId": "Europe/London",
      "customerId": 12345
    },
    {
      "customerCode": "CUST002",
      "customerName": "Tech Solutions Ltd",
      "notes": "Software development company",
      "geographicTimezoneId": "Europe/London",
      "customerId": 12346
    }
  ]
}

Error Responses​

400 Bad Request​

Returned for invalid request parameters:

{
  "applicationMessage": "Invalid request format",
  "consumerMessage": "The request could not be processed"
}

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 customers:

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

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
x-nonce-token: MDU4ZmQ5Y2EtNTExNi00N2E0LWI0Y2EtNjM1YWRjZTZjYmNi
x-app-token: d1d0ecac-3cca-48ef-a4c3-83005c6376ca
x-user-credential: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Usage Notes​

  • Pagination: This endpoint returns all customers in a single response. For large datasets, consider implementing client-side pagination
  • Permissions: The response only includes customers the authenticated user has permission to access
  • Performance: For systems with many customers, this endpoint may take some time to respond
  • Caching: Consider caching customer lists if your application frequently needs this data
  • Empty Response: If no customers are found, an empty array is returned rather than an error