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

# (Client) Retrieve a Job

This operation returns an object containing information about a specified job resource, which describes a runnable configuration such as a scan or a vuln retest.

# 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}": {
      "get": {
        "tags": [
          "Job API v1.0"
        ],
        "summary": "(Client) Retrieve a Job",
        "description": "This operation returns an object containing information about a specified job resource, which describes a runnable configuration such as a scan or a vuln retest.",
        "operationId": "fetchClientJob",
        "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": "display_instances",
            "in": "query",
            "description": "Display information on any instances for each job. An instance represents a specific run of a job at a point in time, so it is possible for a job to have many instances.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "0",
              "example": "0",
              "enum": [
                "0",
                "1"
              ]
            }
          },
          {
            "name": "display_schedule",
            "in": "query",
            "description": "Display information on the active schedule, if any, for this job.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "0",
              "example": "0",
              "enum": [
                "0",
                "1"
              ]
            }
          },
          {
            "name": "format",
            "in": "query",
            "description": "Format of results.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "xml",
              "example": "json",
              "enum": [
                "json",
                "xml",
                "csv"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Provides the information of client jobs.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Job"
                }
              },
              "application/xml": {
                "example": "XML preview is currently not supported."
              },
              "text/csv, text/comma-separated-values": {
                "schema": {
                  "type": "string",
                  "description": "Column headers for data that may be returned using this format.",
                  "example": "id,begin,data,duration,end,href,job,name,requested_status,status,timestamp"
                }
              }
            }
          },
          "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": {
      "JobInstance": {
        "properties": {
          "end": {
            "type": "number",
            "nullable": true
          },
          "requested_status": {
            "type": "string"
          },
          "begin": {
            "type": "number",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "type": "string",
            "nullable": true
          },
          "href": {
            "type": "string"
          },
          "timestamp": {
            "type": "number"
          },
          "id": {
            "type": "number"
          },
          "job": {
            "type": "number"
          },
          "duration": {
            "type": "number",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          }
        }
      },
      "JobTarget": {
        "properties": {
          "type": {
            "type": "string"
          },
          "application": {
            "properties": {
              "id": {
                "type": "number"
              },
              "label": {
                "type": "string"
              },
              "href": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "site": {
            "properties": {
              "id": {
                "type": "number"
              },
              "label": {
                "type": "string"
              },
              "href": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "id": {
            "type": "number"
          }
        }
      },
      "JobWhitelist": {
        "properties": {
          "use_patterns": {
            "type": "boolean"
          },
          "patterns": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "pattern": {
                  "type": "string"
                },
                "id": {
                  "type": "number"
                }
              }
            }
          },
          "use_urls": {
            "type": "boolean"
          }
        }
      },
      "JobSchedule": {
        "properties": {
          "name": {
            "type": "string"
          },
          "api-version": {
            "type": "number"
          },
          "creator": {
            "type": "string",
            "nullable": true
          },
          "start_date": {
            "type": "string",
            "nullable": true
          },
          "job": {
            "properties": {
              "id": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "id": {
            "type": "string"
          },
          "specs": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "time": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                },
                "cron_spec": {
                  "type": "string"
                },
                "id": {
                  "type": "string"
                },
                "duration": {
                  "type": "number",
                  "nullable": true
                }
              }
            }
          },
          "timezone": {
            "type": "string"
          },
          "href": {
            "type": "string"
          }
        }
      },
      "Job": {
        "properties": {
          "creator": {
            "type": "string",
            "nullable": true
          },
          "href": {
            "type": "string"
          },
          "id": {
            "type": "number"
          },
          "jobtype": {
            "type": "string"
          },
          "instances": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/JobInstance"
            }
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "target": {
            "$ref": "#/components/schemas/JobTarget"
          },
          "whitelist": {
            "$ref": "#/components/schemas/JobWhitelist"
          },
          "schedule": {
            "$ref": "#/components/schemas/JobSchedule"
          }
        }
      }
    }
  },
  "x-explorer-enabled": false,
  "x-readme": {
    "proxy-enabled": true
  }
}
```