Example call - all possible standard parameters

This example is from the activities API. However, similar parameters can be used in most API calls.

Parameter	Description	Examples	Explanation	Links
Action	Defines the the API call.	action=viewlist	If not specified records for the API area are returned, or its structure
<General>	Parameters described in overview	user=user&password=user&version=3.1	Username, password and API version	v3.1 Overview
Company	The company context	company=1	Synergist company
Style	Which kind of data is required	style=modelstructure / style=modeldata	Request either meta-data (structure) or actual data
Modelstructure	Name of model required	Modelstructure=activitylist / Modelstructure=activitydetails	Defines the fields returned. There are two available models	Using models
activityid	ID of a specific record	activityid=4833	Used to identify a specific record or filter the output using a key field	Filters
View	ID for a pre-existing query (called a “view”)	view=-1700	Use the “views.json” call to obtain these values	Table of views
Collection	Data collection support	collection=new / collection=<collection ID>	Optional - used to improve API performance (advanced option)
Type	The data area	type=activity	Specifies the area this API all relates to
Input	JSON array	`{"data": [{"activityDetails":"Meeting at BoundryMill","activityID":6958,"activityRecordVersionNumber":1}] }`
page	Data page to return	page=1	Page numbering starts at 0
rows	Number of records/rows to return.	rows=2	0 = return all rows
Response	Returned data	See below	A JSON string containing the data available for this area, for the specified company/user