[ List of API Functions ] [ Frequently Asked Questions ]
Example using GET: [Base URL]?[parameter]=[value]
| Required | Parameter | Description | Type | Size |
|---|---|---|---|---|
| search | Filter by a search string. | string | 255 | |
| rows_per_page | Number of rows/records returned for the request. Maximum of 50 may be returned. | number | ||
| page_number | Sets the offset page number to scroll to. Maximum of 25 (if you need further, use filters or search to better limit the results to a manageable number). | number | ||
| show_columns | Instead of returning the data results, return a list of the available columns that can be used in filters and to format the result data. Defaults to 'no'. | boolean | ||
| sort | id for a column to sort by. Retrieve id options from show_columns. | string | 128 | |
| sort_direction | desc or asc. | string | 10 | |
| display_column | One or more id values from show_columns to indicate which columns to display in the results. | string | ||
| filter | Column-specific filter in the format: 'ID;OPERATOR;SEARCH'. Id can be obtained from show_columns. Operators are lessthan, greaterthan, equalto, contains, doesnotcontain, doesnotequal, nearzipcode, datebetween, between, isempty, or isexactly (operators may not be available for all fields. The search includes the boolean/wildcard string to search against the column using the specified operator. | string |