Skip to content

User

Query format
[Qualifier.* ,|^] [Search.?] [Sort.?]
Multiple qualifers can be provided with ,|^
comma = OR, caret = AND
Queries
all users
all admin
current user
id:<some user id>
given|except users [..id|email list]
given|except groups [..id|handle list]
given|except channels [..id|handle list]
given|except labels [..handle list]
given|except programs [..id|handle list]
given|except kind [..id|handle list]
given|except active [..id|handle list]
given cohorts [..id list]
followers as current|id
following as current|id
direct as current|id
related as current|id
cohort as current|id
program as current|id
Program date ranges
program starting [Date range] with [states]
program ending [Date range] with [states]
states = active|completed|graduated|
withdrawn|incomplete|refunded
State
status = any
status = active
status = retired
participant = member
participant = trainer
participant = observer
participant-state in [states]

Search
where [keyword op '..match..' c?]* c: or | and
Keywords
any, name, first, last,
email, phone, timezone, id,
membership, external, login,
joined
Operators
is, not, starts, ends, contains,
empty, before, after
Sort
sort by <field> asc?|desc?
Fields: last, first, name, start, end