Retrieve client
curl --request GET \
--url https://woes.dev/api/v1/clients/{clientId} \
--header 'Authorization: Bearer <token>'const url = 'https://woes.dev/api/v1/clients/{clientId}';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://woes.dev/api/v1/clients/{clientId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://woes.dev/api/v1/clients/{clientId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"client": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"healthScore": {
"score": 50,
"activity": 50,
"conversations": 50,
"resolutions": 50,
"reasons": [
"<string>"
]
},
"metrics": {
"conversations": 1,
"openConversations": 1,
"messages": 1,
"verifiedContacts": 1,
"visits": 1
},
"channels": [
{
"channel": "<string>",
"count": 1
}
],
"contacts": [
{
"id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"identitySource": "<string>",
"lastMessageAt": "2023-11-07T05:31:56Z",
"online": true,
"visits": 1
}
],
"recentConversations": [
{
"id": "<string>",
"channel": "<string>",
"subject": "<string>",
"preview": "<string>",
"lastMessageAt": "2023-11-07T05:31:56Z"
}
],
"tasks": [
{
"id": "<string>",
"subject": "<string>",
"preview": "<string>",
"priority": "<string>",
"lastMessageAt": "2023-11-07T05:31:56Z"
}
],
"firstContactAt": "2023-11-07T05:31:56Z",
"lastMessageAt": "2023-11-07T05:31:56Z",
"latestConversationId": "<string>"
},
"truncated": true
}{
"code": "unauthorized",
"error": "A valid workspace API key is required."
}{
"code": "insufficient_scope",
"error": "This API key is missing the required scope."
}{
"code": "not_found",
"error": "Record not found."
}{
"code": "rate_limited",
"error": "Too many API requests. Slow down and try again shortly."
}{
"code": "internal_error",
"error": "The API request could not be completed."
}Retrieve client
Retrieves one client account aggregate from the API key workspace. Missing or cross-workspace ids return 404.
GET
https://woes.dev
/
api
/
v1
/
clients
/
{clientId}
Retrieve client
curl --request GET \
--url https://woes.dev/api/v1/clients/{clientId} \
--header 'Authorization: Bearer <token>'const url = 'https://woes.dev/api/v1/clients/{clientId}';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://woes.dev/api/v1/clients/{clientId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://woes.dev/api/v1/clients/{clientId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"client": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"healthScore": {
"score": 50,
"activity": 50,
"conversations": 50,
"resolutions": 50,
"reasons": [
"<string>"
]
},
"metrics": {
"conversations": 1,
"openConversations": 1,
"messages": 1,
"verifiedContacts": 1,
"visits": 1
},
"channels": [
{
"channel": "<string>",
"count": 1
}
],
"contacts": [
{
"id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"identitySource": "<string>",
"lastMessageAt": "2023-11-07T05:31:56Z",
"online": true,
"visits": 1
}
],
"recentConversations": [
{
"id": "<string>",
"channel": "<string>",
"subject": "<string>",
"preview": "<string>",
"lastMessageAt": "2023-11-07T05:31:56Z"
}
],
"tasks": [
{
"id": "<string>",
"subject": "<string>",
"preview": "<string>",
"priority": "<string>",
"lastMessageAt": "2023-11-07T05:31:56Z"
}
],
"firstContactAt": "2023-11-07T05:31:56Z",
"lastMessageAt": "2023-11-07T05:31:56Z",
"latestConversationId": "<string>"
},
"truncated": true
}{
"code": "unauthorized",
"error": "A valid workspace API key is required."
}{
"code": "insufficient_scope",
"error": "This API key is missing the required scope."
}{
"code": "not_found",
"error": "Record not found."
}{
"code": "rate_limited",
"error": "Too many API requests. Slow down and try again shortly."
}{
"code": "internal_error",
"error": "The API request could not be completed."
}Authorizations
Workspace API key that starts with woesk_. Paste your own key into the docs playground; never expose it in browser code.
Path Parameters
Client id returned by the Clients API.
Response
Client found.
Hide child attributes
Hide child attributes
Allowed value:
"client"Available options:
attention, healthy, watch Hide child attributes
Hide child attributes
Available options:
attention, healthy, watch Required range:
0 <= x <= 100Required range:
0 <= x <= 100Required range:
0 <= x <= 100Required range:
0 <= x <= 100Hide child attributes
Hide child attributes
Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Hide child attributes
Hide child attributes
Required range:
x >= 0Hide child attributes
Hide child attributes
Available options:
open, waiting, solved Last modified on July 4, 2026
Was this page helpful?
⌘I
