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 | More Info |
|---|---|---|---|
| Action | Defines the API call. | action=update | Typically CRUD verbs |
| User | User name | user=username | |
| Password | Password | password=MyPassword123 | see Hashing Hashing - Sha512 |
| Version number | API version | version=4 | Incremented for each new version of Synergist |
| Company | Synergist company | company=1 | |
| Activityid | ID of a specific record | activityid=4833 | Filters |
| View | ID for a pre-existing query (called a “view”) | view=-1700 | Table of views |
| Collection | Data collection support | collection= /new | Advanced option |
| Type | The data area | type=activity | Which API to use |
| 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 |
| Style | Which kind of data is required | style=modelstructure / style=modeldata | Using models / Meta-data |
| Modelstructure | Defines the fields returned | Modelstructure=activitylist | Using models |
| Input | JSON array | see example | Passing data array to an API request |