Key parameters

Example call - all possible standard parameters

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

  <th>
    Description
  </th>

  <th>
    Examples
  </th>

  <th>
    Explanation
  </th>

  <th>
    Links
  </th>
</tr>

  <td>
    Defines the API call.
  </td>

  <td>
    action=update
  </td>

  <td>
    If not specified records for the API area are returned, or its structure
  </td>
</tr>

<tr>
  <td>
    <General>
  </td>

  <td>
    Parameters described in overview
  </td>

  <td>
    user=user\&password=user\&version=3.3
  </td>

  <td>
    Username, password and API version
  </td>

  <td>
    [v3.3 Overview](ref:v30xxx-overview)
  </td>
</tr>

<tr>
  <td>
    Company
  </td>

  <td>
    The company context
  </td>

  <td>
    company=1
  </td>

  <td>
    Synergist company
  </td>
</tr>

<tr>
  <td>
    Style
  </td>

  <td>
    Which kind of data is required
  </td>

  <td>
    style=modelstructure / style=modeldata
  </td>

  <td>
    Request either meta-data (structure) or actual data
  </td>

  <td>
    [Using models](ref:using-models)
  </td>
</tr>

<tr>
  <td>
    Modelstructure
  </td>

  <td>
    Name of model required
  </td>

  <td>
    Modelstructure=activitylist / Modelstructure=activitydetails
  </td>

  <td>
    Defines the fields returned. There are two available models
  </td>

  <td>
    [Using models](ref:using-models)
  </td>
</tr>

<tr>
  <td>
    Activityid
  </td>

  <td>
    ID of a specific record
  </td>

  <td>
    activityid=4833
  </td>

  <td>
    Used to identify a specific record or filter the output using  a key field
  </td>

  <td>
    [Filters](ref:filters)
  </td>
</tr>

<tr>
  <td>
    View
  </td>

  <td>
    ID for a pre-existing query (called a “view”)
  </td>

  <td>
    view=-1700
  </td>

  <td>
    Use the “views.json” call to obtain these values
  </td>

  <td>
    [Table of views](ref:views-1)
  </td>
</tr>

<tr>
  <td>
    Collection
  </td>

  <td>
    Data collection support
  </td>

  <td>
    collection=new / collection=&lt;collection ID&gt;
  </td>

  <td>
    Optional - used to improve API performance (advanced option)
  </td>
</tr>

<tr>
  <td>
    Type
  </td>

  <td>
    The data area
  </td>

  <td>
    type=activity
  </td>

  <td>
    Specifies the area this API all relates to
  </td>

  <td>
    [Which API to use](ref:which-api-to-use)
  </td>
</tr>

<tr>
  <td>
    Input
  </td>

  <td>
    JSON array
  </td>

  <td>
    {"data":

    [{"activityDetails":"Meeting at BoundryMill","activityID":6958,"activityRecordVersionNumber":1}]

    }
  </td>

  <td>

  </td>

  <td>
    [Passing data array to an API request](ref:passing-data-to-an-api-call)
  </td>
</tr>

<tr>
  <td>
    Page
  </td>

  <td>
    Data page to return
  </td>

  <td>
    page=1
  </td>

  <td>
    Page numbering starts at 0
  </td>
</tr>

<tr>
  <td>
    Rows
  </td>

  <td>
    Number of records/rows to return.
  </td>

  <td>
    rows=2
  </td>

  <td>
    0 = return all rows
  </td>
</tr>

<tr>
  <td>
    Response
  </td>

  <td>
    Returned data
  </td>

  <td>
    See below
  </td>

  <td>
    A JSON string containing the data available for this area, for the specified company/user
  </td>
</tr>