EmailAccounts
Search EmailAccounts
Search and list EmailAccount records with filtering, sorting, and pagination.
GET
Search EmailAccounts
An EmailAccount configures an incoming email connection (IMAP) used to receive messages for the help desk or other automated workflows. Each account specifies server connection details, credentials, and message handling policies.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the EmailAccount-List role.Enums
eEmailServerType — IncomingServerType values
eEmailServerType — IncomingServerType values
eMessageDeletionPolicy — DeleteMessageSettings values
eMessageDeletionPolicy — DeleteMessageSettings values
Query Parameters
Pagination & Sorting
Filters
Range Filters
Filter by the incoming server port value for this email account greater than or equal to this value.
Filter by the incoming server port value for this email account less than or equal to this value.
Filter by the outgoing server port value for this email account greater than or equal to this value.
Filter by the outgoing server port value for this email account less than or equal to this value.
Filter by date/time value for last check time greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by date/time value for last check time less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by iD of the last message associated with this record greater than or equal to this value.
Filter by iD of the last message associated with this record less than or equal to this value.
Code Examples
Simple listing
Filtering by DisplayName
Range filters
Response
200
The list of EmailAccount records matching the query. See the Get one EmailAccount endpoint for the full list of properties returned for each record.
Example Response