Search
You can also search freely if you request a list of data. You can only enter 1 search term.
Enter the search term with the ?search= parameter. The search term is not case sensitive and you must pass a URL encoded (to enter a space you can use '+').
eg. ?search=Ghent
Filter data
If you request a list of data, you can filter this list by only including items with specific data.
Pass a list of the desired values along the parameter ?filter=. You can only filter on fields of the highest level (so not of lower levels). As the first value you pass the name of the field followed by a comparison sign and then the actual value. The possible comparison characters are =, !=, <=, >=, <, >, =~ (=contains the text). All values must be passed URL-encoded. Multiple filters can be placed one after the other with a comma sign.
eg. ?filter=city%3DBrussel,name%3D%7ERestaurant
URL encodings:
- Equal to (=): %3D
- Different from (!=): %21%3D
- Less than or equal (<=): %3C%3D
- Greater than or equal (>=): %3E%3D
- Less than (<): %3C
- Greater than (>): %3E
- Contains (=~): %3D%7E
- Space (‘ ‘): +
Restrict returned fields
If you request a list of data, you can decide which fields are to be displayed. If you do not specify any, all fields are displayed.
Enter a list of the desired fields with the parameter ?fields=. You can only pass in fields of the highest level and not of the lower levels.
E.g. ?fields=name,email_address
To sort
If you request a list of data, you can sort this list ascending or descending on a few fields.
You cannot sort on all fields. If you specify a field that cannot be sorted, an error message will be displayed.
For the domain 'activities' there is no sorting possible.
Pass a list of the desired fields along the ?sort= parameter. Multiple fields can be separated with a '+' (URL-encoded = %2B). To sort a field in descending order, place a minus sign in front of it.
eg. ?sort=status%2B-date
Pagination
If you request a list of data, you can only request part of this list. This is useful for enabling pagination.
It is strongly recommended to always collect a maximum of 100 documents per request when collecting documents (invoices, quotations, etc.).
To skip data use the parameter ?skip= and to limit the amount of data use parameter ?take=.
eg. ?skip=30&take=10
Formatting
Texts can be entered in the Markdown format which adds formatting. See also How to format text? Texts returned through the API contain the specified formatting codes in Markdown format, however it is also possible to convert them to the appropriate formatting in HTML.
To convert texts use the parameter ?markup=markdown.