Skip to main content
GET
List the workspace's sync plans.

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.

Query Parameters

status
enum<string>[]

Filter to plans in any of these lifecycle statuses.

Lifecycle state of a SyncPlan.

Available options:
generating,
ready,
approved,
executing,
done,
failed,
done_with_errors,
invalidated
workerId
string<uuid>

Filter to plans with an operation for this worker id.

kind
enum<string>[]

Filter to plans of any of these kinds (default: policy).

What a SyncPlan was generated to do.

Available options:
policy,
adoption,
reset
q
string

Case-insensitive match on the name of any policy the plan evaluated.

Required string length: 3 - 100
sort
enum<string>

Order the results by this column (default: newest requested).

Available options:
requested_at,
status,
generated_at,
approved_at,
completed_at,
approved_by
dir
enum<string>

Sort direction for sort (default: descending).

Available options:
asc,
desc
approvedBy
string<uuid>[]

Filter to plans approved by any of these users.

requestedBy
string<uuid>[]

Filter to plans requested by any of these users.

requestedBySystem
boolean

Include plans the schedule requested, alongside any requestedBy given.

completedFrom
string

Filter to plans completed at or after this instant.

completedTo
string

Filter to plans completed at or before this instant.

cursor
integer<int32>
limit
integer<int32>

Response

OK

The envelope for a collection response: IReadOnlyList<T> ApiCollectionResponse<T>.Results.

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

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