Skip to content
/End Users

List end users

Request

Lists all end users in an organization. It is possible to filter by one of the mutually exclusive parameters: email or phone number. In case both are provided, an error is returned.
Note: Custom attributes are not part of the response at this point. If you need to get custom attributes for a user use the GET /endusers/{userId} endpoint

Security
ApiKeyAuth
Query
pageLimitinteger, (int32)

Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.

pageKeystring

Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.

emailstring

Filter by the contact's email

phonestring

Filter by the contact's phone number

externalIdstring

Filter by the contact's external id

GET
/beta/endusers
curl -i -X GET \
  'https://dev.dixa.io/beta/endusers?pageLimit=0&pageKey=string&email=string&phone=string&externalId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The list of end users

Bodyapplication/json
dataArray of objects(EndUser)
metaobject(PaginationLinks)
Response
{
  "data": [
    { … },
    { … },
    { … },
    { … }
  ]
}