Skip to content
Dixa API/
/
Get end user

Get end user

Request

Get an end user by id.

Security
ApiKeyAuth
Path
userIdstring, (uuid)required

The end user id

GET
/v1/endusers/{userId}
curl -i -X GET \
  'https://dev.dixa.io/v1/endusers/{userId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The end user

Bodyapplication/json
dataobject(EndUser)required
Response
{
  "data": {
    "id": "434ce9f5-14c8-4be1-a0a8-f755010deb9b",
    "createdAt": "2020-12-16T09:41:43Z",
    "displayName": "Alice Brown",
    "email": "alice@brown.com",
    "phoneNumber": "+551155256325",
    "additionalEmails": [ … ],
    "additionalPhoneNumbers": [ … ],
    "firstName": "Alice",
    "lastName": "Brown",
    "middleNames": [],
    "avatarUrl": "https://files.dixa.io/public/image_id",
    "externalId": "#12345678",
    "customAttributes": [ … ]
  }
}