...
To begin, you will want to identify which API call you need/want to perform. Each call serves it’s own purpose and has a specific response. The response may dictate which API call you need to perform because this shows you the data that is being returned.
Please see our available APIs are listed here: API DocsDocumentation
The APIs are split into different categories based on what type of function they serve. You will also see there are also Import calls, Update calls, and Query calls. Import calls send data into the CRM, Update calls updates data in the CRM, and Query calls return data out of the CRM.
When you click on an API option, you will be presented with the purpose of the call, any notes specific to that call, the data dictionary, and a sample response.
The data dictionary shows each available parameter that you can use to filter your API request. However, some Some parameters are required and will show a “Y” under the “Required' column. Each parameter also shows a description and how to acquire the value. Some of these can also be located within the CRM.
The sample response will show you the data that is returned upon performing that API call.
...