admin-users-list

GET /api/v1.0/users/

List users. Search users by email, full name or maildomain. A search query of at least 3 characters is required.

Request

  • The document declares no server URL.
  • Auth
    API key in cookie sessionid

Query parameters

maildomain_pkstring uuid

Filter users by maildomain.

qstring

Search users by full name, short name or email.

Response

idstring uuid required

primary key for the record as UUID

emailstring email nullable required
full_namestring nullable required
custom_attributesobject required

Get custom attributes for the instance.

Changes

No recorded changes to this operation across all 60 revisions of this API.