GET Whitelisting Domains with Pagination

Overview

---

The following table provides information about the GET method used to retrieve all whitelisting domains as a list, based on specified request parameters.

GET Whitelisting Domains with Pagination
Method	GET
URL or Endpoint	/api/projects/projectId/whitelisting-domains
Headers	Authorization
Parameters	search(query), order(query), insertedDate(query), page(query), take(query), projectId
Body	Not Applicable

The description of the URL parameter is as follows:

projectId Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

The description of the parameters is as follows:

Parameter Name	Mandatory	Type	Description
search	No	string	Search for a specific domain.
order	No	string	Specifies the sorting order.
insertedDate	No	string($date-time)	Date when the domain was inserted.
page	No	integer($int32)	A specific page with whitelisting domains.
take	No	integer($int32)	Number of whitelisting domains to take.
api-version	No	string	API version.

Request Body

The GET method doesn't contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "currentPage": 1,
    "totalPages": 1,
    "pageSize": 10,
    "totalCount": 2,
    "items": [
      {
        "id": 1,
        "domain": "{domain}",
        "insertDate": "2025-03-17T12:36:17.624Z",
        "active": false
      },
      {
        "id": 2,
        "domain": "{domain}",
        "insertDate": "2025-03-17T12:37:36.730Z",
        "active": false
      }
    ]
  },
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear in the response is displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful, it will return true. Otherwise, it will return false.
errors	array[string]	Indicates if there was an error.
messages	array[string]	Returns any messages from the back-end.
result	object	The main object containing the paginated result details.
currentPage	integer	The current page number being returned.
totalPages	integer	Total number of available pages.
pageSize	integer	The number of items displayed per page.
totalCount	integer	The total number of items across all pages.
items	array[object]	An array containing the list of items for the current page.
id	integer	The unique identifier of the whitelisted domain.
domain	string	The whitelisted domain.
insertDate	string (DateTime)	The date and time when the domain was inserted.
active	bool	Indicates if the domain is active.
resultInfo	nullable	Returns additional information about the result (if any).
statusCode	integer	Returns the HTTP status code (e.g., 200).

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed