Skip to main content
GET
List clients

Authorizations

Authorization
string
header
default:woesk_your_api_key_here
required

Workspace API key that starts with woesk_. Paste your own key into the docs playground; never expose it in browser code.

Query Parameters

Search by client id, name, channel, or contact.

Required string length: 1 - 160
health
enum<string>

Filter clients by computed health label.

Available options:
attention,
healthy,
watch
limit
integer
default:20

Number of records to return.

Required range: 1 <= x <= 100

Response

Client list.

object
string
required
Allowed value: "list"
hasMore
boolean
required
truncated
boolean
required
clients
object[]
required
Last modified on July 4, 2026