Skip to content

MngGetLead

Returns one lead by customer_id.

The command is available through the manager command API only; there is no REST path for it. The kind is fixed by the command name, so customer_kind is not accepted on input. See Clients and Leads Commands.

It replaces the deprecated MngGetCustomer, which served both kinds. The paired command for the other kind is MngGetClient.

Access Control

Allowed sessions:

  • SESSION_MANAGER
  • SESSION_ADMIN
  • SESSION_DEALER
  • SESSION_CRM_MANAGER
  • SESSION_CRM_ADMIN

The caller must have CRM access and see_leads. The record brand and desk must be inside the manager scope; see_all_leads widens the desk scope within the brand.

If the manager does not have see_leads_contacts, email and phone are returned masked.

Request

{
  "command": "MngGetLead",
  "extID": "1",
  "data": {
    "customer_id": 1
  }
}

Request Data

Field Type Required Description
customer_id int Yes Target customer id, 1 or greater

Response Data

{
  "customer": {
    "customer_id": 1,
    "email": "[email protected]",
    "phone": "+35700000000",
    "full_name": "John Smith",
    "status": 0,
    "lifecycle_flags": 0,
    "customer_kind": 0,
    "conversion_flags": 0,
    "deposit_allowed": 1,
    "withdrawal_allowed": 1
  }
}

Field meanings are listed in Customer Fields.

Errors

HTTP Error Description
400 INVALID_DATA Request validation failed
400 RET_INVALID_DATA The customer exists but is not a lead
403 RET_NOT_ENOUGH_RIGHTS Missing permission, missing scope, or the record is outside the caller's visibility
404 RET_NOT_FOUND No customer with that identifier exists

Every error carries a message field with free-form text. Its contents are not part of the contract; branch on error.