Skip to main content
GET
Search sync plan operations

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 operation kinds.

What change the operation proposes against the target system, or against the record.

Available options:
create,
update,
set_link,
set_grants,
forget,
set_claims,
adopt,
detach,
set_elements,
end_element,
reset_password
system
enum<string>[]

Filter by any of these target systems.

An external system a workspace can connect to.

Available options:
adp_workforce_now,
oracle_fusion,
microsoft_entra,
gusto,
microsoft365,
google_workspace,
oracle_oci,
worker_model,
aws,
azure,
aws_identity_center,
bamboo_hr,
slack,
github,
github_enterprise,
salesforce,
hubspot,
box,
linear,
dropbox,
openai,
anthropic,
one_password,
keeper,
bitwarden,
atlassian,
notion
cause
enum<string>[]

Filter by any of these causes.

Why a plan proposes an operation.

Available options:
declared,
released,
worker_left_segment,
target_left_policy,
policy_deleted,
worker_gone,
account_gone,
matched,
unlinked,
rehired,
manually_requested
status
enum<string>[]

Filter by any of these statuses.

Per-operation execution state, recorded when the plan runs.

Available options:
pending,
succeeded,
failed,
blocked,
skipped,
retrying
workerId
string<uuid>[]

Filter by any of these worker ids.

q
string

Case-insensitive match on the worker'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

Cursor-pagination metadata shared across every paged read. nextCursor is the offset of the next page, null on the last page.