Get Customer Details by Customer ID Using the API

When you want to retrieve the details of a customer account using the customer ID. This article explains the required parameters and API request format for fetching customer profile, contact, account, and status information.

Getting Customer Details By Id

Description

Gets the Customer details for the specified Customer Id.

Parameters

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Authentication Parameter
api-key	String	Required	Authentication Parameter
customer-id	Integer	Required	Customer Id of the Customer

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/customers/details-by-id.json?auth-userid=0&api-key=key&customer-id=0

Response

Returns a hash map containing the below details:

Customer Id (customerid)
Customer Username (username)
Reseller Id of the Parent Reseller (resellerid)
Name (name)
Company (company)
Email Address (useremail)
Telephone Number Country Code (telnocc)
Telephone Number (telno)
First line of address of the Customer (address1)
Second line of address of the Customer (address2)
Third line of address of the Customer (address3)
City (city)
State (state)
Country Code (country)
ZIP Code (zip)
Personal Identification Number (pin)
Creation Date (creationdt)
Current Status (customerstatus)
Sales Contact Id (salescontactid)
Language Preference for the Control Panel and Emails (langpref)
Total Receipts (totalreceipts)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Did you find this article helpful?