User API Filters

Filter parameters to help you filter the user data retrieved via our User API.

Filter Parameters for /api/users GET Endpoint

The GET endpoint /api/users to retrieve users provides a filter parameter that supports filtering using the SCIM notation.

PropertyFilter operatorAllowed values
groupsis member (eq)
not member (ne)
{groupID}
staffbase.creationTypeequal to (eq)
  • bonding
  • csv
  • direct
  • ldap
  • scim
  • sso
staffbase.role
User Role Type
equal to (eq)
  • admin
  • editor
  • moderator
  • managingEditor
  • reader
staffbase.spaceis member (eq){spaceID}
staffbase.statusequal to (eq)
  • activated (default)
  • deactivated
  • pending
updated
The point in time when the user was last updated.
gt, ge, le, lt, eq, neThe value for the point in time is dynamic. Examples:
  • 2021-07-07
  • 2021-07-07T10:00
  • 2021-07-07T10:00:00.000Z
User typepresent (pr)
  • emails
  • externalId
  • password
  • staffbase.recoveryCode
  • userName

Examples

1// Only members of the given group ID
2groups eq "604fab5e830203614e6fa59d"
3
4// Only members part of the given space ID
5staffbase.space eq "5fc7743d3dd910548d350a2a"
6
7// Only registered admin users
8staffbase.status eq "activated" and staffbase.role eq "admin"
9
10// Only users created via CSV import or SSO
11staffbase.creationType eq "csv" or staffbase.creationType eq "sso"
12
13// Custom profile fields (use the profile field ID for data import)
14profile.{fieldID} eq "value"
15
16// -------------------- //
17// Different User Types //
18// -------------------- //
19
20// Only users with primary email or username and Staffbase password
21(emails pr or userName pr) and password pr
22
23// Only access code users (no primary email and username)
24(not (emails pr) and not (userName pr) and password pr)
25
26// Only SSO users (identifier, but no Staffbase password)
27(externalId pr and not (password pr))
28
29// ---------------------- //
30// Filter for Date & Time //
31// ---------------------- //
32
33// All users that were updated since day = 2021-07-07, time = 10:00
34updated gt "2021-07-07T10:00"
35
36// All users that were *not* updated since day = 2021-05-24
37updated lt "2021-05-24"

Hint: Since filter is a URL parameter, whitespaces (space = %20) and quotes (" = %22) have to be URL encoded.

Example: only access code users, so no existing primary email and username

https://backend.staffbase.com/api/users?filter=(not%20(emails%20pr)%20and%20not%20(userName%20pr)%20and%20password%20pr)

Read more