Skip to main content
GET
List connection accounts

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

scope
enum<string>

Which of the connection's accounts to list (default: all).

Available options:
all,
managed,
unmanaged,
ignored
q
string

Case-insensitive match on the account's handle, its id, or its worker's name.

Required string length: 2 - 200
sort
enum<string>

Order the results by this column (default: handle).

Available options:
display_handle,
worker,
read_at
dir
enum<string>

Sort direction for sort (default: ascending).

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

Only accounts recorded against one of these workers.

stage
enum<string>[]

Only accounts whose worker is in one of these lifecycle stages.

A stage in a worker's lifecycle that a policy configures behavior for.

Available options:
pre_start,
active,
leave,
suspended,
departing,
terminated
policy
string<uuid>[]

Only accounts one of these policies claims.

unclaimed
boolean

Include accounts no policy claims, alongside any policy given.

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.