List SupportEmailAddresses

GET {{baseUrl}}/api/v1/supportEmailAddress?departmentId=<long>

This API lists the SupportEmailAddresses configured in your help desk.

OAuth Scope

  • Desk.settings.READ
  • Desk.basic.READ

Request Params

KeyDatatypeRequiredDescription
departmentIdstringID of the department(s) from which the SupportEmailAddresses must be fetched.
fromstringIndex number, starting from which the mail addresses must be fetched
limitstringNumber of mail addresses to fetch

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;data&quot;:[{&quot;address&quot;:&quot;marketing@zylker.com&quot;,&quot;departmentId&quot;:&quot;4000000007043&quot;,&quot;id&quot;:&quot;4000000025003&quot;,&quot;friendlyName&quot;:&quot;Marketing&quot;,&quot;isMailFetching&quot;:true},{&quot;address&quot;:&quot;sales@zylker.com&quot;,&quot;departmentId&quot;:&quot;4000000007043&quot;,&quot;id&quot;:&quot;4000000026001&quot;,&quot;friendlyName&quot;:&quot;Sales&quot;,&quot;isMailFetching&quot;:false},{&quot;address&quot;:&quot;support@zylker.com&quot;,&quot;departmentId&quot;:&quot;4000000007043&quot;,&quot;id&quot;:&quot;4000000026003&quot;,&quot;friendlyName&quot;:&quot;Support&quot;,&quot;isMailFetching&quot;:true}]}