Get Client

This API retrieves complete details for a client based on the provided ClientName filter. The ClientName parameter is mandatory and must match the exact name of the client you want to look up. When a valid client name is provided, the API returns a full record of that client such as Name, Address, Agency Name, Status and Access etc.

Responses

🟢200OK

application/json

Body

Example

{
    "Id": 0,
    "ClientName": "string",
    "ClientId": "string",
    "HomeBranch": "string",
    "FirstName": "string",
    "LastName": "string",
    "Email": "string",
    "Phone": "string",
    "PhysicalAddress1": "string",
    "PhysicalAddress2": "string",
    "PhysicalAddressZip": "string",
    "PhysicalAddressCity": "string",
    "PhysicalAddressStateCode": "string",
    "Status": "string",
    "Fax": "string",
    "Website": "string",
    "Notes": "string",
    "IsBillSameAsMail": true,
    "IsShipSameAsMail": true,
    "BillAddress1": "string",
    "BillAddress2": "string",
    "BillZip": "string",
    "BillCity": "string",
    "BillStateCode": "string",
    "ShipAddress1": "string",
    "ShipAddress2": "string",
    "ShipZip": "string",
    "ShipCity": "string",
    "ShipStateCode": "string",
    "CreditLimit": true,
    "MaxCreditLimit": 0,
    "CreditLimitWarning": 0,
    "CreditLimitEmailNotification": "string",
    "AllowOrderCreation": true,
    "IsTLMAccess": true,
    "CreatedDate": "string",
    "RecordRoles": [
        {}
    ],
    "CustomData": [
        {}
    ]
}

Request

Responses