Get Client Profile by External ID

Permissions

  ----
  Permissions:INTEGRATOR,OPERATOR,SUPERVISOR
  ----

HTTP Request

GET /api/v1/clients/ext/profile HTTP/1.1
Authorization: Bearer <integrator_token>
Host: localhost:8080

HTTP Response Variables

PathTypeDescription
 externalClientIdstring Unique identifier for the client in a third-party system
fullNamestring Client’s name from the third-party system
segmentstringClient’s segment
phonestringCustom field that can be used to show the client’s phone number. This field doesn’t contain a title.
emailstringCustom field that can be used to show the client’s email address. This field doesn’t contain a title.
blockedbooleanValue that defines whether the client is blocked
additional[].keystringExample: balance
additional[].valuestringExample: 10000

Example of a Successful HTTP Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 313
{
    "externalClientId": "ext",
    "fullName": "Oleg Olegovich Smirnov",
    "email": "email@mail.ru",
    "phone": "79000000000",
    "segment": "VIP",
    "blocked": false,
    "additional": [
        {
            "key": "balance",
            "value": "1000.0"
        },
        {
            "key": "packetLeft",
            "value": "10 min"
        }
    ]
}