Get App Profile by Customer ID

This API is used to retrieve a customer's application profile for a given appid and customer profile key. The appid is a unique ID for individual channel assets.


Know Your Endpoint

Based on the domain you use to log in to imiconnect, the endpoint for your API varies. See the endpoint section to understand which endpoint to use for your domain.


For data privacy and security reasons, the REST API is served over encrypted HTTPS. The standard HTTP is not supported.

Response Parameters
StatusNumberZero indicates success response
DescriptionStringDescribes the status of API call
RecordsArrayAn array of Outward links and Inward links
Record[].AttributesArrayOutward links and Inward links
Attributes[].NameStringName of the column. For example, CustomerId -Column Name
Attributes[].ValueStringValue Contained with in the column Eg: CustomerId- 1234
Attributes[].IDNumberSystem generated unique Id for the column
InwardLinksArrayShows app profiles mapped to the Customer Id
OutwardLinksArrayDisplays customer profile information on Get app profile call
OutwardLinks[].ProfileIdNumberUnique system Generated ID on profile store creation
OutwardLinks[].ProfileNameStringProfile store Name
OutwardLinks[].RecordsArrayList of columns mapped to the profile store Eg: Customer Id,Name,Mobile No etc.
OutwardLinks[].Records[].ValueStringValue Contained with in the column Eg: CustomerId- 1234
OutwardLinks[].Records[].IDNumberSystem generated unique Id for the column
OutwardLinks[].Records[].NameStringName of the column Eg : CustomerId -Column Name
codeStringInternal code handling by imiconnect
transidStringUnique system generated id for API call
Response CodeMessageDescription
1000SuccessReturned when the request is completed successfully.
7000Invalid JSONReturned when an invalid JSON request is sent.
7001Authentication failedReturned when the invalid service key or profile key is provided in the request.
7003Mandatory parameters missingReturned when the mandatory parameters configured in custom event are missing