Articles in this section

API Guidelines and Retrieving Variables

Avatar
Support
Follow

Developer API

What is it?

The Developer API is an HTTP-based programming interface that allows developers to interact with the platform to extend and enhance its functionality. The API allows for any application to both read and write in your firm. It is RESTful and uses JSON(JavaScript Object Notation) as the exchange format. SSL is mandatory and used for all communication.

What can it do?

  • Create new sales leads
  • Modify marketing targets & target lists
  • Manage jobs & candidates
  • Manage company events & news stories
  • Create support tickets logged by customers.

Who is it for?

This guide is designed for developers with basic knowledge of web services & XML, in addition to a programming language of your choice.

HTTP methods

GET and POST methods are for request-response action, these two methods are mainly used for object retrieval, creation and the actions performed.

GET

Used for object retrieval only

POST

Used for object creation and object actions

Formats

The JSON standard is followed with the API. This means that the API can only receive JSON lists or objects. JSON values must be of the correct type. IDs and numbers in general must be integers, not strings. The output also displayed in JSON format.

Sample Format

The sample format of requesting URL for creating a contact in the Contacts App:

 

https://www.apptivo.com/app/dao/v6/contacts?a=save&contactData={CONTACT_DATA}&;apiKey=API_KEY&accesKey=ACCESS_KEY

The slash followed by method with case data collection, API key and Access key. The output of the above JSON request URL receives output with the same JSON format.

 

Steps to Create an API Integration

Below are the steps to generate the API in various functionalities:

To receive your API key and Access key, please send a request including your business name, personal name, and account login username to support@tech-toolbox.co

    

Create Contact API

Log in and access ‘Contacts’ App from your universal navigation menu bar.

 

         

Now, you will be navigated to the ‘Create page’ of Contacts App. Even before creating a contact using ‘Create’ option on the left side menu, click on “F12” key (or) right click the mouse for the “Inspect” option to navigate into the ‘Inspect View’ that will be displayed at the bottom of the Apptivo page as shown below:

 

 

Click on ‘Clear Console’ option as highlighted to clear the cache before you navigate into the ‘Network’ section.

 

Now, select for the ‘Network’ option, before you start with the contact creation.

 

 Start creating the contact keeping the ‘Inspect page’ opened at the bottom of the page.

 

 

You can also have this ‘Inspect page’ docked to right side of the page as below:

 

Fill in the mandatory fields and click on ‘Create’ button at the bottom of the page.

 

Once a contact is created with the ‘Inspect page’ open at the bottom, the necessary API’s will be generated accordingly. Now search and select for the “Contact?a=save” from the Name section. After clicking on it you will be displayed with the “Request URL” under the headers tab as shown below:

 

 

Scroll down to check for the ‘Form data’ under the headers tab as shown below.

 

Prepare a code now with the ampersand symbol included between each of the following(Request URL, Form Data(Contact Data), API Key, Access Key):

 

https://www.apptivo.com/app/dao/v6/contacts?a=save&contactData={"customAttributes":[],"title":null,"firstName":"Arun","externalRefId":"","lastName":"Isravel","jobTitle":"","contactTypeName":"E-Commerce User","contactType":221153,"accountName":"","customerNumber":"","accountId":null,"customerNumberId":null,"supplierName":"","supplierId":null,"assigneeObjectRefName":"Services Demo","assigneeObjectRefId":46374,"assigneeObjectId":"8","contactCategoryName":"","categoryId":null,"description":"","skypeName":"","phoneticName":"","nickName":"","dateOfBirth":"","marketName":"","marketId":null,"segmentName":"","segmentId":null,"territoryName":"","territoryId":null,"industryName":"","industryId":null,"hobbies":"","foods":"","faceBookURL":"","twitterURL":"","linkedInURL":"","website":"","createdByName":"","lastUpdatedByName":"","creationDate":"","lastUpdateDate":"","labels":[],"contactStatusName":"Active","contactStatusId":10000,"isPrimary":"Y","bestWayToContactName":"Email","bestWayToContactId":10000,"accounts":[],"isUnsubscribed":"N","isBounced":"N","isResponded":"N","bouncedReason":null,"languageCode":"en","languageName":"English","phoneNumbers":[{"phoneNumber":"223634564","phoneType":"Business","phoneTypeCode":"PHONE_BUSINESS","id":"contact_phone_input"}],"emailAddresses":[{"emailAddress":"isravell@gmail.com","emailTypeCode":"BUSINESS","emailType":"Business","id":"cont_email_input"}],"createdBy":null,"lastUpdatedBy":null,"contactCategoryIds":[],"categories":[],"syncToGoogle":"N","addresses":[{"addressAttributeId":"address_section_attr_id","addressTypeCode":"1","addressType":"Billing Address","addressLine1":"","addressLine2":"","city":"","stateCode":"","addressGroupName":"Address1","state":"","zipCode":"","countryId":70,"countryName":"India","countryCode":"IN","deliveryInstructions":null,"county":null}],"lastContactedDate":null}&uDxzzQzKVBtQ-BuIrPUYtUYPqQr-a89bc062-1c8f-460d-b7fc-edd17f947ab4&421E9G8H5d19B9A0

 

 Now copy and paste this whole code in your browser as shown below. Once done, you will be generated with a API as shown below.

 

You can now make use of this generated API on your need.

The same procedure can be followed for the ‘Create functionality’ in all the other respective apps.

Alternative usage: You can also replace the Request URL with ‘www’ as ‘api or api2’, even for this the same API will be generated.

 

Create Customer API

  1. Prepare a code now with the ampersand symbol included between each of the following(Request URL, Form Data(Customer Data), API Key, Access Key):

 

https://www.apptivo.com/app/dao/v6/customers?a=save&customerData={"customAttributes":[],"customerId":null,"customerName":"Arun Rajah","customerNumber":"Auto generated number","customerCategory":"","customerCategoryId":null,"statusName":"Active","statusId":10000,"defaultBillingCurrency":"INR","assigneeObjectRefName":"Services Demo","assigneeObjectRefId":46374,"assigneeObjectId":8,"description":"","phoneNumber":"","contactEmail":"","skypeName":"","parentCustomerName":"","parentCustomerId":null,"employeeRange":"","employeeRangeId":null,"website":"","tickerSymbol":"","annualRevenue":null,"annualRevenueCurrencyCode":"INR","campaignName":"","campaignId":null,"creditRating":"","marketName":"","marketId":null,"segmentName":"","segmentId":null,"industryName":"","industryId":null,"paymentTerm":"Net 30","paymentTermId":69976,"ownership":"","slaName":"","slaId":null,"isUnsubscribed":"N","accounts":[],"territories":[],"isBounced":"N","bouncedReason":null,"isResponded":"N","followUpDate":null,"followUpDescription":null,"createdByName":"","lastUpdatedByName":"","creationDate":"","lastUpdateDate":"","isExistingCustomer":"N","isAffiliate":"N","faceBookURL":"","twitterURL":"","linkedInURL":"","createdBy":null,"lastUpdatedBy":null,"labels":[],"phoneNumbers":[{"phoneNumber":"4656545646","phoneType":"Business","phoneTypeCode":"PHONE_BUSINESS","id":"cust_phone_input"}],"removePhoneNumbers":[],"emailAddresses":[{"emailAddress":"rajah@gmail.com","emailTypeCode":"BUSINESS","emailType":"Business","id":"cont_email_input"}],"addresses":[{"addressAttributeId":"address_section_attr_id","addressTypeCode":"1","addressType":"Billing Address","addressLine1":"","addressLine2":"","city":"","stateCode":"","addressGroupName":"Address1","state":"","zipCode":"","countryId":70,"countryName":"India","countryCode":"IN","deliveryInstructions":null,"county":null}],"lastContactedDate":null}&isLeadConvert=N&isDuplicate=false&uDxzzQzKVBtQ-BuIrPUYtUYPqQr-a89bc062-1c8f-460d-b7fc-edd17f947ab4&421E9G8H5d19B9A0

 

  1. After the process you can now make use of this generated API on your need.

Create Items API

  1. Prepare a code now with the ampersand symbol included between each of the following(Request URL, Form Data(CreateItem Data), API Key, Access Key):

 

https://www.apptivo.com/app/dao/v6/items?a=save&createItemData={"isEnabled":true,"itemCode":"Autogeneratednumber","billsOfMaterialType":"Standard","billsOfMaterialTypeId":"bills_of_materials_standard","assigneeObjectRefName":"ServicesDemo","assigneeObjectRefId":46374,"assigneeObjectId":"8","itemCondition":"New","itemConditionId":21189572,"inventoryType":"Purchased","inventoryTypeId":0,"customAttributes":[],"itemPriceCurrencyCode":"INR","currencyCode":"INR","costCurrencyCode":"INR","enabledForSales":"Yes","labels":[],"tags":[],"isDirtypage":null,"itemPrice":"500.00","itemName":"Watch","customAttributeValueId":"bills_of_materials_standard","shape":"","color":"","attributeValues":[{"attributeId":"bills_of_materials_standard","attributeValue":"Standard","shape":"","color":""}],"categories":[],"taxCode":null,"trackSize":"","minOrderQuantity":0}&uDxzzQzKVBtQ-BuIrPUYtUYPqQr-a89bc062-1c8f-460d-b7fc-edd17f947ab4&421E9G8H5d19B9A0

 

  1. After the process you can now make use of this generated API on your need.

Create Kit Orders API

 

  1. Prepare a code now with the ampersand symbol included between each of the following(Request URL, Form Data(CreateItem Data), API Key, Access Key):

 

https://www.apptivo.com/app/dao/v6/kitorders?a=save&kitOrderData={"kitOrderNumber":"Auto generated number","discountTypeName":"PERCENTAGE","discountType":"%","discountValue":"10.00","currencyCode":"INR","subTotal":1000,"total":900,"shippingAndHandling":"0.00","employeeId":46577,"customAttributes":[],"itemList":[{"unitPriceCurrencyCode":"INR","currencyCode":"INR","itemAmountCurrencyCode":"INR","supplierPriceCurrencyCode":"INR","supplierAmountCurrencyCode":"INR","itemName":"Football","itemId":225368,"attributeValues":[{"id":13,"attributeId":225368,"attributeValue":"Football"}],"customAttributeType":"referenceField","attributeId":"item_code_attr","objectId":13,"objectRefId":225368,"refFieldObjectRefId":225368,"fieldType":"input","itemCode":"1","customAttributeValue":"1","refFieldObjectRefName":"1","undefined":"1","quantity":1,"supplierName":"","supplier_name_select":null,"supplierId":null,"supplierNumber":null,"supplierPrice":null,"supplierAmount":null,"taxCode":"","taxId":null,"unitPrice":1000,"itemNote":"","rowNote":"","itemAmount":1000,"itemDiscount":100,"itemTax":0,"supplierItemId":null,"amount":1000}],"labels":[],"tags":[],"subTotalCurrencyCode":"INR","discountAmountCurrencyCode":"INR","taxAmountCurrencyCode":"INR","shippingAndHandlingCurrencyCode":"INR","totalCurrencyCode":"INR","isDirtypage":null,"assigneeObjectRefName":"Arun Apptivo","assigneeObjectRefId":46577,"assigneeObjectId":"8","updateAutocomplete":true,"customerName":"Arun Isravel","customerId":914668,"customer_input":914668,"discountAmount":100,"taxAmount":0,"fromObjectId":174}&yCOxOzWzVVGT-ExjKlEvGJOxzzS-e0b7a209-c4f3-478b-8388-321391c8cc22&4H3I10109Mw4l18l

 

After the process you can now make use of this generated API on your need.

 

Advanced Search for Contacts

Click on the ‘Advanced Search’ option with the Inspect page opened.

 

A pop-up will emerge with all the fields, where you can opt for any field using which you need to do an advanced search.

 

After you click the search button, you will be displayed with the search result based on the search criteria performed.

Click the “contacts?a=getAllByAdvancedSearch” under Name category, now you will be displayed with the ‘Request URL’ as shown below:

  

Now, scroll down to make use of the ‘Form data’ under the headers tab as highlighted below.

 

Prepare a code now with the ampersand symbol included between each of the following(Request URL, Form Data(Contact Data), API Key, Access Key):

 

https://www.apptivo.com/app/dao/v6/contacts?a=getAllByAdvancedSearch&startIndex=0&numRecords=50&sortColumn=lastName.sortable&sortDir=asc&iDisplayLength=50&iDisplayStart=0&sSortDir_0=asc&multiSelectData={"marketIds":[],"segmentIds":[],"contactTypeIds":[],"industryIds":[]}&searchData={"title":"","accountId":null,"isPrimary":null,"isBounced":null,"categories":[],"addresses":[{"addressAttributeId":"address_section_attr_id","addressGroupName":"Address1","addressType":"","state":"","stateCode":"","stateId":null,"stateName":""}],"phoneNumbers":[],"emailAddresses":[{"emailAddress":"isravell@gmail.com","id":"cont_email_input"}],"customAttributes":[],"labels":[]}&status=0&uDxzzQzKVBtQ-BuIrPUYtUYPqQr-a89bc062-1c8f-460d-b7fc-edd17f947ab4&421E9G8H5d19B9A0

 

Now copy and paste this whole code in your browser as shown below. Once done, you will be generated with a API as shown below.

 

You can now make use of this generated API on your need.

The same procedure can be followed for the ‘Advanced Search functionality’ in all the other respective apps.

Alternative usage: You can also replace the Request URL with ‘www’ as ‘api or api2’, even for this the same API will be generated.

 

Advanced Search for Customers

  1. Prepare a code now with the ampersand symbol included between each of the following(Request URL, Form Data(Customers Data), API Key, Access Key):

 

https://www.apptivo.com/app/dao/v6/customers?a=getAllByAdvancedSearch&startIndex=0&numRecords=50&iDisplayLength=50&iDisplayStart=0&searchData={"customerName":"","customerNumber":"","assigneeObjectRefName":null,"assigneeObjectId":null,"assigneeObjectRefId":null,"description":"","followUpDescription":"","phoneNumbers":[],"emailAddresses":[{"emailAddress":"rajah@gmail.com","id":"cont_email_input"}],"skypeName":"","parentCustomerName":"","parentCustomerId":null,"website":"","tickerSymbol":"","campaignName":"","campaignId":null,"creditRating":"","territoryName":"","territoryId":null,"ownership":"","faceBookURL":"","twitterURL":"","linkedInURL":"","isUnsubscribed":null,"isBounced":null,"isResponded":null,"creationOnStartDate":"","creationOnEndDate":"","creationDateDuration":"","creationDateDurationTypeId":"","creationDateRangeTypeId":"","lastUpdateOnStartDate":"","lastUpdateOnEndDate":"","lastUpdateDateDuration":"","lastUpdateDateDurationTypeId":"","lastUpdateDateRangeTypeId":"","customAttributes":[],"addresses":[{"addressAttributeId":"address_section_attr_id","addressGroupName":"Address1","addressType":"","state":"","stateCode":"","stateId":null,"stateName":""}]}&multiSelectData={"marketIds":[],"categoryIds":[],"statusIds":[],"employeeRangeIds":[],"paymentTermIds":[],"slaIds":[],"industryIds":[],"segmentIds":[]}&uDxzzQzKVBtQ-BuIrPUYtUYPqQr-a89bc062-1c8f-460d-b7fc-edd17f947ab4&421E9G8H5d19B9A0

 

Now copy and paste this whole code in your browser as shown below. Once done, you will be generated with a API as shown below. You can now make use of this generated API on your need.

 

Advanced Search for Items

  1. Prepare a code now with the ampersand symbol included between each of the following(Request URL, API Key, Access Key):

 

https://www.apptivo.com/app/dao/v6/items?a=getAllByAdvancedSearch&iDisplayLength=50&iDisplayStart=0&multiSelectData=%7B%22itemTaxIds%22:%5B%5D,%22itemConditionIds%22:%5B%5D,%22categoryIds%22:%5B%5D,%22inventoryTypeIds%22:%5B%5D%7D&numRecords=50&objectId=13&sSortDir_0=&searchData=%7B%22itemName%22:%22Watch%22,%22customAttributes%22:%5B%5D%7D&sortColumn=creationDate&sortColumnType=&sortDir=&startIndex=0&t=1512744551535&uDxzzQzKVBtQ-BuIrPUYtUYPqQr-a89bc062-1c8f-460d-b7fc-edd17f947ab4&421E9G8H5d19B9A0

 

Now copy and paste this whole code in your browser as shown below. Once done, you will be generated with a API as shown below. You can now make use of this generated API on your need.

 

Show All for Items

Click on the ‘Show All’ option with the Inspect page opened.

 

After you click the show all button, you will be displayed with the search result based on the search criteria performed.

Click the “items?a=getAll&iDisplayLength=50” under Name category, now you will be displayed with the ‘Request URL’ as shown below:

 

Prepare a code now with the ampersand symbol included between each of the following(Request URL, API Key, Access Key):

 

https://www.apptivo.com/app/dao/v6/items?a=getAll&iDisplayLength=50&iDisplayStart=0&numRecords=50&objectId=13&objectStatus=0&sSortDir_0=desc&selectedTab=show-all&sortColumn=creationDate&sortColumnType=&sortDir=desc&startIndex=0&t=1512744667959&trash=false&uDxzzQzKVBtQ-BuIrPUYtUYPqQr-a89bc062-1c8f-460d-b7fc-edd17f947ab4&421E9G8H5d19B9A0

 

Now copy and paste this whole code in your browser as shown below. Once done, you will be generated with a API as shown below.

 

You can now make use of this generated API on your need.

The same procedure can be followed for the ‘Advanced Search functionality’ in all the other respective apps.

Alternative usage: You can also replace the Request URL with ‘www’ as ‘api or api2’, even for this the same API will be generated.

Comments

0 comments

Please sign in to leave a comment.