GET Whitelisting Domain by ID

Overview

---

The table below provides information about the GET method for retrieving a whitelisted domain by its ID.

GET Whitelisted Domain by ID
Method	GET
URL or Endpoint	/api/projects/projectId/whitelisting-domains/id
Headers	Authorization
Parameters	id, projectId
Body	Not Applicable

URL Parameters

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
projectId	Yes	string	Unique ID of the project.
id	Yes	integer	Unique ID of the whitelisted domain.

Request Body

The GET method doesn't contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": 0,
    "domain": "string",
    "insertDate": "2025-04-02T06:51:43.373Z",
    "active": true
  },
  "resultInfo": "string",
  "statusCode": 200
}

Information about the fields that appear when you receive the response are 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 messages from the back-end.
result	object	The main object containing the whitelisted domain details.
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	string	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