Get a client by ID
Changed onReturns a single client including full contact details, service and billing addresses, tags, ad group, notes, additional contacts, and custom field values.
Request
- Base URLhttps://api.workiz.com/crm/api
- Authnone declared. Required headers: Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The client ID (prefix CL-).
Headers
Bearer Token
Response
The requested client.
Example response
{
"id": "CL-OvmDp2yvv1yqMwRl",
"serialId": 1023,
"firstName": "John",
"lastName": "Doe",
"fullName": "John Doe",
"companyName": "John Doe Inc.",
"description": "This is a description",
"email": "john.doe@example.com",
"primaryExt": "123",
"primaryPhone": "1234567890",
"secondaryExt": "456",
"secondaryPhone": "1234567890",
"country": "USA",
"state": "NY",
"city": "New York",
"zipcode": "10001",
"unit": "100",
"address": "123 Main St",
"serviceAddress": "123 Main St, New York, NY 10001",
"billingAddress": "123 Main St, New York, NY 10001",
"allowBilling": true,
"taxExempt": true,
"taxExemptReason": "9",
"adGroup": {
"id": "AG-71b8d7310acbf8cc",
"name": "Ad Group 1"
},
"tags": [
{
"id": "TAG-211d1676f4b90c40",
"name": "Tag 1",
"color": "#edce4c"
}
],
"parentClient": {
"id": "CL-OvmDp2yvv1yqMwRl",
"serialId": 1023,
"firstName": "John",
"lastName": "Doe",
"fullName": "John Doe",
"companyName": "John Doe Inc.",
"description": "This is a description",
"email": "john.doe@example.com",
"primaryExt": "123",
"primaryPhone": "1234567890",
"secondaryExt": "456",
"secondaryPhone": "1234567890",
"country": "USA",
"state": "NY",
"city": "New York",
"zipcode": "10001",
"unit": "100",
"address": "123 Main St",
"serviceAddress": "123 Main St, New York, NY 10001",
"billingAddress": "123 Main St, New York, NY 10001",
"allowBilling": true,
"taxExempt": true,
"taxExemptReason": "9"
},
"clientContacts": [
{
"id": "CLC-211d1676f4b90c40",
"firstName": "John",
"lastName": "Doe",
"fullName": "John Doe",
"email": "john.doe@example.com",
"primaryPhone": "1234567890",
"secondaryPhone": "1234567890",
"country": "USA",
"state": "NY",
"city": "New York",
"zipcode": "10001",
"address": "123 Main St",
"role": "Property Manager",
"note": "Prefers contact by email."
}
],
"notes": [
{
"id": "CLN-211d1676f4b90c40",
"note": "Customer requested a follow-up call.",
"techName": "John Doe",
"createdAt": "2021-01-01 00:00:00"
}
],
"customFields": [
{
"id": "CF-eYLPK7198xVp6Z8q",
"fieldName": "Custom Field 1",
"value": "John Doe"
}
],
"created": "2026-01-01 00:00:00"
}Changes
- info
added the media type
application/jsonfor the response with the status - info
added the media type
application/jsonfor the response with the status - info
added the media type
application/jsonfor the response with the status - info
added the non-success response with the status
- info
added the non-success response with the status
- info
- info
added the optional property
to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status
- info