Skip to main content
GET
/
clients
Retrieves all clients available to the authenticated user.
curl --request GET \
  --url https://api.example.com/clients
[
  {
    "id": 123,
    "name": "<string>",
    "phone": "<string>",
    "city": "<string>",
    "street": "<string>",
    "country": "<string>",
    "zipCode": "<string>",
    "about": "<string>",
    "primaryNumber": "<string>",
    "portalId": 123,
    "email": "<string>",
    "nationalId": "<string>",
    "acceptedTermsAt": "2023-11-07T05:31:56Z",
    "totalCalls": 123,
    "lastCallAt": "2023-11-07T05:31:56Z",
    "callLengthInSeconds": 123,
    "callsLast7Days": 123,
    "isUnknown": true,
    "memory": "<string>",
    "isInactive": true,
    "isDeleted": true,
    "language": "<string>",
    "alfaECareDetails": "<string>",
    "isCustomerService": true
  }
]

Response

Successfully retrieved the list of clients.

id
integer<int32>
name
string | null
phone
string | null
city
string | null
street
string | null
country
string | null
zipCode
string | null
about
string | null
primaryNumber
string | null
portalId
integer<int32>
email
string | null
nationalId
string | null
acceptedTermsAt
string<date-time> | null
totalCalls
integer<int32>
lastCallAt
string<date-time> | null
callLengthInSeconds
integer<int32>
callsLast7Days
integer<int32>
isUnknown
boolean
memory
string | null
isInactive
boolean
isDeleted
boolean
language
string | null
alfaECareDetails
string | null
isCustomerService
boolean