--- title: Get a Scheduled Job slug: feature-experimentation/api/get-a-scheduled-job docTags: createdAt: 2026-10-01T19:58:02.336Z --- { "id": "4oid5WFOqaKIXAWmT9oys", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.optimizely.com/v2/scheduled-jobs/{job_id}", "servers": [ { "url": "https://api.optimizely.com/v2/scheduled-jobs/{job_id}" } ], "name": "Get a Scheduled Job", "description": "Get a Scheduled Job by ID", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "job_id", "type": "integer", "description": "The ID of the Scheduled Job you'd like to get", "format": "int64" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKey", "name": "apiKey", "kind": "optional", "type": "http", "scheme": "bearer" }, { "id": "OAuth2", "name": "OAuth2", "kind": "optional", "type": "oauth2", "description": "

Write applications that authenticate with the REST API via OAuth 2.0. Or, to authenticate using a personal token, see https://docs.developers.optimizely.com/web/docs/personal-token

", "oauth2Flows": { "authorizationCode": { "authorizationUrl": "https://app.optimizely.com/oauth2/authorize", "tokenUrl": "https://app.optimizely.com/oauth2/token", "scopes": { "all": "Full access to your account" } } }, "requiredScopes": [ "read", "write" ] } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Return Scheduled Job info", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ScheduledJob", "schema": [ { "name": "account_id", "kind": "optional", "type": "integer", "readOnly": true, "description": "The account that the job is associated with", "example": 456, "format": "int64" }, { "name": "archived", "kind": "optional", "type": "boolean", "readOnly": true, "description": "Whether the Scheduled Job is archived", "example": false, "default": false }, { "name": "campaign_ids", "kind": "optional", "type": "array", "description": "

A list of campaign_ids that should be considered during the job

", "example": "[12,34]", "default": [], "itemType": "integer", "customType": "integer[]", "itemExample": "", "itemDefault": "" }, { "name": "experiment_ids", "kind": "optional", "type": "array", "description": "

A list of experiment_ids that should be considered during the job

", "example": "[56,78,90]", "default": [], "itemType": "integer", "customType": "integer[]", "itemExample": "", "itemDefault": "" }, { "name": "frequency", "kind": "required", "type": "string", "description": "How often the job should be performed", "example": "weekly", "enum": [ "daily", "weekly" ] }, { "name": "id", "kind": "optional", "type": "integer", "readOnly": true, "description": "The unique identifier of the Scheduled Job", "example": 123, "format": "int64" }, { "name": "job_type", "kind": "required", "type": "string", "description": "The type of job to be performed", "example": "project_results", "enum": [ "project_results" ] }, { "name": "output_channels", "kind": "optional", "type": "object", "description": "An object describing how the output of the job should be communicated", "example": "{\"email\": [\"test@example.com\", \"another@example.com\"]}", "default": {}, "schema": [] }, { "name": "project_id", "kind": "required", "type": "integer", "description": "The project that the job is associated with", "example": 789, "format": "int64" } ], "modelRef": "#/components/schemas/ScheduledJob", "isExpanded": true } ] }, { "statusCode": "400", "description": "Invalid ID supplied", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Error", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "messages", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "uuid", "kind": "optional", "type": "string", "description": "", "format": "uuid" } ], "modelRef": "#/components/schemas/Error", "isExpanded": true } ] }, { "statusCode": "401", "description": "Invalid credentials", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Error", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "messages", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "uuid", "kind": "optional", "type": "string", "description": "", "format": "uuid" } ], "modelRef": "#/components/schemas/Error", "isExpanded": true } ] }, { "statusCode": "403", "description": "You do not have permission to access the specified Scheduled Job", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Error", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "messages", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "uuid", "kind": "optional", "type": "string", "description": "", "format": "uuid" } ], "modelRef": "#/components/schemas/Error", "isExpanded": true } ] }, { "statusCode": "404", "description": "Scheduled Job not found", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Error", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "messages", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "uuid", "kind": "optional", "type": "string", "description": "", "format": "uuid" } ], "modelRef": "#/components/schemas/Error", "isExpanded": true } ] }, { "statusCode": "default", "description": "Unexpected error", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Error", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "messages", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "uuid", "kind": "optional", "type": "string", "description": "", "format": "uuid" } ], "modelRef": "#/components/schemas/Error", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "VjbfikJiRk78f-OefUHN9", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.optimizely.com/v2/scheduled-jobs/{job_id} \\\n --header 'accept: application/json'" }, { "id": "h-CODevniT-hu1W9FJR3U", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.optimizely.com/v2/scheduled-jobs/{job_id}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "PJiKX4pS46QdxIN2xLe3c", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.optimizely.com/v2/scheduled-jobs/{job_id}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "s94OoT52Rtgv6iDu6-L0g", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.optimizely.com/v2/scheduled-jobs/{job_id}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "VjbfikJiRk78f-OefUHN9" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Return Scheduled Job info\n{\n \"account_id\": 456,\n \"archived\": false,\n \"campaign_ids\": [\n 0\n ],\n \"experiment_ids\": [\n 0\n ],\n \"frequency\": \"weekly\",\n \"id\": 123,\n \"job_type\": \"project_results\",\n \"output_channels\": {},\n \"project_id\": 789\n}" }, { "id": "response-1-400", "language": "400", "code": "// Invalid ID supplied\n{\n \"code\": \"\",\n \"message\": \"\",\n \"messages\": {},\n \"uuid\": \"\"\n}" }, { "id": "response-2-401", "language": "401", "code": "// Invalid credentials\n{\n \"code\": \"\",\n \"message\": \"\",\n \"messages\": {},\n \"uuid\": \"\"\n}" }, { "id": "response-3-403", "language": "403", "code": "// You do not have permission to access the specified Scheduled Job\n{\n \"code\": \"\",\n \"message\": \"\",\n \"messages\": {},\n \"uuid\": \"\"\n}" }, { "id": "response-4-404", "language": "404", "code": "// Scheduled Job not found\n{\n \"code\": \"\",\n \"message\": \"\",\n \"messages\": {},\n \"uuid\": \"\"\n}" }, { "id": "response-5-default", "language": "default", "code": "// Unexpected error\n{\n \"code\": \"\",\n \"message\": \"\",\n \"messages\": {},\n \"uuid\": \"\"\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }