Integration Guide

If you're loading your SharePoint page from an external system, you can dynamically pass filter values via the URL:

The format for the filtering URL parameters follows the same schema as SharePoint List filtering.

For example:

FilterField1=<field internal name>&FilterValue1=<field value to search for>&FieldType1=<field type>

Additionally, another parameter is supported: FilterName1. This can optionally be used to customise the display name of the field being filtered.

Finding your field internal name and type

The field internal name can be retrieved by inspecting your List page. The easiest way to do this is to filter the list by your field:

When you do this, the URL parameters will be added to the page - and you can just copy these:

If your field name contains spaces, the internal name may be encoded with "_x0020_" characters. This is normal and a valid part of the internal name.

Filtering on multiple fields

If you are filtering on multiple fields, then you can increment the number of the end of the parameters: FilterField2, FilterValue2, etc.

Last updated