You can use these filter expressions to restrict the number of users returned:
- filter=userName eq "<attribute-value-here>"
- filter=externalId eq "<attribute-value-here>"

📘

Note

• The attribute names must be either userName or externalId.

• Only the eq attribute operator is available.

See the examples at the right pane for better understanding.

For more information about how to build the filter expression, refer to https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2

Paginating results with startIndex and count

Results are returned one page at a time. Use two query parameters to control which users you receive:

• startIndex — the 1-based index of the first user to return. A value less than 1 is treated as 1.
• count — the maximum number of users to return per page. The default is 10 and the maximum is 100.

For example, the request below selects the first 4 users in the list:

https://app.perk.com/api/v2/scim/Users?startIndex=1&count=4

This returns up to 4 users beginning at position 1 (users 1 through 4). To work out exactly which users a request selects, read it as "return count users starting from startIndex". The response confirms the selection through three fields:

• startIndex — the index the page started at (here, 1).
• itemsPerPage — how many users were actually returned on this page (here, up to 4).
• totalResults — the total number of users available across all pages.

To fetch the next page, advance startIndex by count. So after startIndex=1&count=4, the following page is startIndex=5&count=4 (users 5 through 8), and so on. You have retrieved every user once startIndex plus itemsPerPage exceeds totalResults.