---
updatedAt: 2026-05-12T09:58:26.000Z
---

# (Client) Retrieve a whitelist

This operation returns an object containing information about the whitelist information for the specified job.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Job API (Legacy)",
    "contact": {},
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://sentinel.whitehatsec.com"
    }
  ],
  "paths": {
    "/api/{client_id}/job/{job_id}/whitelist": {
      "get": {
        "tags": [
          "Job API v1.0"
        ],
        "summary": "(Client) Retrieve a whitelist",
        "description": "This operation returns an object containing information about the whitelist information for the specified job.",
        "operationId": "getClientWhitelist",
        "parameters": [
          {
            "name": "job_id",
            "in": "path",
            "description": "The ID number of the desired Job resource.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "client_id",
            "in": "path",
            "description": "Client ID.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "format",
            "in": "query",
            "description": "Format of results.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "xml",
              "example": "json",
              "enum": [
                "json",
                "xml"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Provides the list of client whitelist.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/JobWhitelistResponse"
                }
              },
              "application/xml": {
                "example": "XML preview is currently not supported."
              }
            }
          },
          "400": {
            "description": "BadRequestResponse indicates a request with invalid parameters.",
            "content": {}
          },
          "401": {
            "description": "UnauthorizedResponse signals an unauthorized API access.",
            "content": {}
          },
          "403": {
            "description": "ForbiddenResponse signals a request for a resource that does not exist or is not authorized.",
            "content": {}
          },
          "404": {
            "description": "NotFound the requested resource could not be found.",
            "content": {}
          },
          "500": {
            "description": "GenericError generic error.",
            "content": {}
          }
        },
        "deprecated": false
      }
    }
  },
  "components": {
    "schemas": {
      "JobWhitelist": {
        "properties": {
          "use_patterns": {
            "type": "boolean"
          },
          "patterns": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "pattern": {
                  "type": "string"
                },
                "id": {
                  "type": "number"
                }
              }
            }
          },
          "use_urls": {
            "type": "boolean"
          }
        }
      },
      "JobWhitelistResponse": {
        "properties": {
          "whitelist": {
            "$ref": "#/components/schemas/JobWhitelist"
          }
        }
      }
    }
  },
  "x-explorer-enabled": false,
  "x-readme": {
    "proxy-enabled": true
  }
}
```