curl "https://server.smartlead.ai/api/v1/client/456?api_key=YOUR_KEY&includePermissions=true&includeCodeIntegrations=true"
import requests
response = requests.get(
"https://server.smartlead.ai/api/v1/client/456",
params={"api_key": "YOUR_API_KEY", "includeCodeIntegrations": "true"}
)
snippets = response.json()["data"]["client_code_integrations"]
print(snippets)
{
"ok": true,
"data": {
"id": 456,
"uuid": "5b0c1c9e-2f3a-4d7b-9d1e-1a2b3c4d5e6f",
"name": "Acme Client",
"email": "client@acme.com",
"logo": null,
"user_id": 11,
"created_at": "2026-01-10T09:00:00.000Z",
"logo_url": null,
"is_credit_assigned": false,
"mobile_device_id": null,
"ga_view_access": false,
"client_preferences": {},
"client_permissions": [
{ "permission": ["reply_master_inbox"], "retricted_category": [4, 5] }
],
"client_code_integrations": [
{
"id": 12,
"snippet_name": "LinkedIn Outreach",
"snippet_code": "<script>...</script>"
}
]
}
}
{
"message": "Client not found or does not belong to the user"
}
Client Management
Get Client by ID
Fetch a client, optionally with its permissions, credits, code integrations and whitelabel details
GET
/
api
/
v1
/
client
/
{id}
curl "https://server.smartlead.ai/api/v1/client/456?api_key=YOUR_KEY&includePermissions=true&includeCodeIntegrations=true"
import requests
response = requests.get(
"https://server.smartlead.ai/api/v1/client/456",
params={"api_key": "YOUR_API_KEY", "includeCodeIntegrations": "true"}
)
snippets = response.json()["data"]["client_code_integrations"]
print(snippets)
{
"ok": true,
"data": {
"id": 456,
"uuid": "5b0c1c9e-2f3a-4d7b-9d1e-1a2b3c4d5e6f",
"name": "Acme Client",
"email": "client@acme.com",
"logo": null,
"user_id": 11,
"created_at": "2026-01-10T09:00:00.000Z",
"logo_url": null,
"is_credit_assigned": false,
"mobile_device_id": null,
"ga_view_access": false,
"client_preferences": {},
"client_permissions": [
{ "permission": ["reply_master_inbox"], "retricted_category": [4, 5] }
],
"client_code_integrations": [
{
"id": 12,
"snippet_name": "LinkedIn Outreach",
"snippet_code": "<script>...</script>"
}
]
}
}
{
"message": "Client not found or does not belong to the user"
}
Related data is opt-in. With no
include* flags, only the client’s own fields are returned. Use includeCodeIntegrations=true to read the client’s code snippets (for example to get a snippet id to update).Path Parameters
number
required
Client ID
Query Parameters
string
required
Your SmartLead API key (client API keys are not allowed)
boolean
Include
client_permissionsboolean
Include
user_client_creditboolean
Include
client_code_integrationsboolean
Include
user (your account’s whitelabel details)curl "https://server.smartlead.ai/api/v1/client/456?api_key=YOUR_KEY&includePermissions=true&includeCodeIntegrations=true"
import requests
response = requests.get(
"https://server.smartlead.ai/api/v1/client/456",
params={"api_key": "YOUR_API_KEY", "includeCodeIntegrations": "true"}
)
snippets = response.json()["data"]["client_code_integrations"]
print(snippets)
Response
object
The client:
id, uuid, name, email, logo, user_id, created_at, logo_url, is_credit_assigned, mobile_device_id, ga_view_access, client_preferences, plus the requested related sets:client_permissions(withincludePermissions): one-element array of{ permission, retricted_category }(empty array when none).retricted_categoryholds the hidden lead category IDs (the key is spelled this way).user_client_credit(withincludeCredits):{ id, lead_credits, lead_credits_used, email_credits, email_credits_used }ornullclient_code_integrations(withincludeCodeIntegrations): array of{ id, snippet_name, snippet_code }, ordered byiduser(withincludeWhitelabel):{ gpt_api_info, whitelabel_details, display_whitelabel_credentials, wl_google_client_id, wl_microsoft_client_id }
{
"ok": true,
"data": {
"id": 456,
"uuid": "5b0c1c9e-2f3a-4d7b-9d1e-1a2b3c4d5e6f",
"name": "Acme Client",
"email": "client@acme.com",
"logo": null,
"user_id": 11,
"created_at": "2026-01-10T09:00:00.000Z",
"logo_url": null,
"is_credit_assigned": false,
"mobile_device_id": null,
"ga_view_access": false,
"client_preferences": {},
"client_permissions": [
{ "permission": ["reply_master_inbox"], "retricted_category": [4, 5] }
],
"client_code_integrations": [
{
"id": 12,
"snippet_name": "LinkedIn Outreach",
"snippet_code": "<script>...</script>"
}
]
}
}
{
"message": "Client not found or does not belong to the user"
}