Web Method: getCustomersConfigData
This API will provide entire details of Customer’s App which includes the following.
- Response Type: JSON String.
- All Standard and Custom Attribute details which are configured in settings->master Layout.
- It has phoneTypes,emailTypes,AddressTypes, employeeRanges, industries,territories, calendarYears, leadSources, leadTypes, etc., as a Array of objects.
- It returns sectionId, sectionName,attributeId,attributeName,attributeType,etc., as a Array of object inside the webLayout.
Purpose
You can use the getConfigData method to get all the configuration data’s like customer types, market, category and etc.
Request API URL
https://api.apptivo.com/app/dao/v6/customers?a=getConfigData&apiKey=API_KEY&accessKey=ACCESS_KEY
Request Parameters
| Parameter | Data Type | Description |
| apiKey* | String | Apptivo business account API Key |
| accessKey* | String | Apptivo business account Access Key |
* – Mandatory parameters
Output
This will return all the customer configuration data with JSON format.
Notes
- You can get these configuration values and use them while creating customers.
- We can get the webLayout from configData API, which is the JSON string(need to decode to access it).
- Iterate all sections and attributes, to know the attribute details, to create or update the customer records in Apptivo.
Sample API
https://api.apptivo.com/app/dao/v6/customers?a=getConfigData&apiKey=ZMQYFZTzBXAW-DoPSURDtNVBUEY-518d51ae-ab26-4c04-9f7b-8d26a586e90e&accessKey=SqQxOzQZDvUT-fTsOrItIVDUGyV-5c90b8a3-4683-4145-8584-1ed40de970b9
Sample Response
{"phoneTypes":[{phoneType1},{phoneType2},{phoneType3}..], "emailTypes":[{emailType1},{emailType2},{emailType3}..],
"addressTypes":[{addressType1},{addressType2},{addressType3}...],
“employeeRanges”:[{employeeRange1},{employeeRange2},{employeeRange3}..],
“Industries”:[{industry1},{industry2},{industry3}],
“Territories”:[{territory1},{territory2},{territory3}],...etc.,
webLayout:{sections:
[{section1details, "attributes": [{attribute1details},{attribute1details},{attribute1details}..]},
[{section2details, "attributes": [{attribute2details},{attribute2details},{attribute2details}..]},
[{section3details, "attributes": [{attribute3details},{attribute3details},{attribute3details}..]},
[{section4details, "attributes": [{attribute4details},{attribute4details},{attribute4details}..]}
}}
