Build Version:

GET domains

Gets a list of domains.

Request Information

» Filters

Name	Description	Usage
apiKey	This will filter the request by API key.	GET domains?filter=apikey~{operator}~{value}
DomainName	This will filter the request by domain name.	GET domains?filter=domainname~{operator}~{value}
isActive	This will filter the request by the is active flag.	GET domains?filter=isactive~{operator}~{value}
portalId	This will filter the request by portal ID.	GET domains?filter=portalid~{operator}~{value}
webAppType	This will filter the request by WebAppType	GET domains?filter=webapptype~{operator}~{value}

» Sorting

Name	Description	Usage
domainId	This will sort the response by domain ID.	GET domains?sort=domainid
DomainName	This will sort the response by domain name.	GET domains?sort=domainname

» Paging

Name	Description	Usage
index	The index to retrieve when requesting paged results.	GET domains?page=index~{value}
size	The size of the page when retrieving paged results.	GET domains?page=size~{value}

Response Information

» Response Body Formats

If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.

application/json

Sample:

	{
  "Domains": [
    {
      "ApiKey": "5D2B4C5E-D8B3-4488-904D-64094762E136",
      "DomainId": 1,
      "DomainName": "localhost",
      "IsActive": true,
      "PortalId": 1,
      "WebAppType": 1
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "StackTrace": null,
  "AllowHtmlResponse": false,
  "HasError": false,
  "StringResponse": null
}