API-methods

This section describes API-methods that are relevant for “all” integrators, but also methods/endpoints that will be relevant for most integrators.

Almost all API-methods require some authorization, so ask for permission for the relevant methods for your integration.

Please read Best Practice before using any API-endpoints.

Best Practice

OData queries

Use $inlinecount=allpages sparingly Calculating the number of total rows can in some cases use a lot of resources. Try to retrieve the count using the desired $filter just once when reading large amounts of data.

One way of doing this would be to run the following query first:

/flow/api/Category/Method?$inlinecount=allpages&$orderby=X&$filter=Y&$top=0

Then proceed to read the data without requesting the total count:

/flow/api/Category/Method?$orderby=X&$filter=Y&$top=0&$skip=Z

Table of contents