Skip to content
Dixa API/
/
Get agent

Get agent

Request

Get an agent/admin by id.

Security
ApiKeyAuth
Path
agentIdstring, (uuid)required

The agent/admin id

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

Responses

The agent/admin

Bodyapplication/json
dataobject(Agent)required
Response
{
  "data": {
    "id": "4d2ab456-8510-4a35-b266-e502160d5177",
    "createdAt": "2020-12-16T09:41:43Z",
    "displayName": "Alice Brown",
    "email": "alice@brown.com",
    "avatarUrl": "https://files.dixa.io/public/image_id",
    "phoneNumber": "+551155256325",
    "additionalEmails": [ … ],
    "additionalPhoneNumbers": [ … ],
    "firstName": "Alice",
    "lastName": "Brown",
    "middleNames": [],
    "roles": [ … ]
  }
}