List domains

GET {{baseUrl}}/api/v1/domains

This API lists the domains configured in your help desk.

OAuth Scope

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

Request Params

KeyDatatypeRequiredDescription
isVerifiedstringKey that filters domains based on their verification status
isAppliedstringKey that filters domains based on their application status in the help desk

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"appliedTime":null,"sslRequestStatus":null,"sslRequestedBy":null,"isVerified":true,"sslStatus":"NO_SSL","domain":"supportportal.zylker.com","zdSecurityCode":null,"sslRequestedTime":null,"isApplied":false,"appliedBy":null,"verifiedBy":"8000000012800","verifiedTime":"2018-06-03T11:21:07.912Z"},{"appliedTime":null,"sslRequestStatus":null,"sslRequestedBy":null,"isVerified":true,"sslStatus":"NO_SSL","domain":"customers.zylker.com","zdSecurityCode":null,"sslRequestedTime":null,"isApplied":false,"appliedBy":null,"verifiedBy":"8000000012800","verifiedTime":"2018-06-03T11:21:07.654Z"},{"appliedTime":null,"sslRequestStatus":null,"sslRequestedBy":null,"isVerified":true,"sslStatus":"NO_SSL","domain":"partners.zylker.com","zdSecurityCode":null,"sslRequestedTime":null,"isApplied":false,"appliedBy":null,"verifiedBy":"8000000012800","verifiedTime":"2018-06-03T11:21:07.912Z"}]}