Query option $top and $skip

Use the $top and $skip query options to page through a larger result set. You can use these query options alone or together, depending on which records you want in your response.

Component Description

HTTP method

GET

URL

https://host/fmi/odata/version/database-name/table-name{?$top/?$skip}=number

host – FileMaker Cloud or FileMaker Server host name

version – the OData version, always v4

database-name – the name of the hosted database

table-name - the name of the table

Query options {?$top/?$skip} - the $top query option specifies the number of records to include in your results, and the $skip query option specifies the number to omit.

Example:

  • /fmi/odata/v4/ContactMgmt/Contacts?$top=2

    This request returns the first two records from the Contacts table.

  • /fmi/odata/v4/ContactMgmt/Contacts?$skip=19

    This request returns records from the Contacts table starting with the twentieth record.