Skip to main content
GET
Search sync plan fields

Authorizations

klef.session
string
cookie
required

Cookie-based session. Obtain by completing the /auth/login/{provider} OAuth flow; the /auth/callback response sets the klef.session cookie that subsequent requests send automatically.

Path Parameters

id
string<uuid>
required

Query Parameters

kind
enum<string>[]

Filter by any of these kinds of change.

What one consequence of a plan does to the thing it addresses.

Available options:
account_created,
account_disabled,
account_enabled,
field_changed,
element_added,
element_changed,
element_ended,
grant_added,
grant_removed,
link_changed,
record_changed,
claim_added,
claim_removed,
password_reset
system
string[]

Filter by any of these target systems.

A connector: one Klef ships, such as microsoft_entra, or a workspace's own, whose id starts with custom_.

Pattern: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
q
string

Case-insensitive match on the path or the system's name.

Maximum string length: 100
cursor
integer<int32>
limit
integer<int32>

Response

OK

The envelope for a collection response with the counts each of its filters offers: facets.

results
object[]
required
facets
null | object
required
errors
object[]
required
pagination
null | object
required

Where one page sits in a paged read.