Skip to main content

CLIENT MAPPING API

This API returns the complete list of active clients mapped to a dealer.

This endpoint is typically used to fetch client details associated with a dealer account for downstream operations.

🔑 Header Parameters

HeaderTypeDescriptionExample
Content-TypestringSpecifies the media type of the requestapplication/json
AuthorizationstringAccess token for authenticated requests{{access_token}}
x-api-keystringAPI key used to authorize the request{{x-api-key}}

🟢 Success Response - 200 OK

Content-Type: application/json

FieldTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code to user request"s-101"
messagestringSuccess message"Client mapping fetched successfully"
dataobjectClient mapping response payloadRefer to Data Object Fields

📦 Data Object Fields

FieldTypeDescriptionExample
ClientIdstringClient ID"CL12345"
GroupIdstringGroup ID"GRP001"
StatusstringStatus"ACTIVE"