The API lets you fetch lists of data such as projects, jobs, orders, people, configurations and so on.
...
| query | Optional query string using a simple but powerful query language. Example:
| Optional, string? | ||
| fields | Optional array of fields to include in the results. By default, the API returns the most commonly used fields. Use the API method ./list/fields returns all available fields. Example:
| Optional, string[]? | ||
| allfields | If set to true then the query will return all fields. This has the same effect as adding /full to the URL. For performance reasons, we do not recommend this options. | Optional, bool? | ||
| sort
| Defines the sort order of the list. The array contains JSON objects, each with these properties:
Example:
Note: All lists always use a default sort order if none is specified here.
| Optional, object[]? | ||
| take | Optional. Number of element to retrieve (used for pagination). If not specified then default is 20. The maximum value is 500. | Optional, int? | ||
| skip | Optional. Number of element to skip (used for pagination). If not specified then default is 0. | Optional, int? | ||
| agg | Optional. The ID of an aggregation (see ./list/aggregations) to include with the results. If the ID does not exist, the parameter is disregarded. Note that a list's default aggregation always has ID "default". Use with care as this adds substantial search overhead. | Optional, string | ||
| makeDefault | Optional. If set to true then this query, fields and aggregation setting will be saved as the user's default. It is recommended to not use this property. | Optional, bool? |
About fields in results
If you execute a "list/full" query you get:
- All fields.
If you execute a "list" query you get:
- All fields listed in the query's fields parameter
- And all fields with isdata = true (these cannot be removed)
If you execute a "list" query without specifying the fields:
- And all fields with isdata = true or iscoldef = true (the columns displayed by default)
RESULTS
The method returns a JSON object with these properties:
| total | Total number of filtered accounts, i.e. accounts complying with the "filter". | int |
| count | Number of returned rows. | int |
| rows | Array of rows each containing all the field values. Each row contains the fields listed in layout.cols | array<object> |
| agg | Included if the request specified a valid aggid parameter. This is then the result of the aggregation. Example with jobs lists: The total of jobs per job status. See ./list/aggregations/{id} (post) for a detailed description of format. | object? |
| querytree | If the query is composed of ".Matches()" and "AND" clauses only (info), this property returns a JSON graph of the query. | object? |
Each element in rows contains the field values:
...