--- title: /v1/events/batch/jobs/{jobId} slug: v1eventsbatchjobsjobid docTags: createdAt: 2026-07-05T23:31:07.866Z --- { "id": "A_hw6U3X921O4jLZDGDbK", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.throughlinecare.com/v1/events/batch/jobs/{jobId}", "description": "Poll a batch job's status.", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "jobId", "type": "string", "description": "" } ], "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": "bearerAuth", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Enter the token with the \"Bearer: \" prefix e.g. \"Bearer ABC...\"

", "in": "header" } ] }, "responses": [ { "statusCode": "200", "description": "Job complete.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Job complete.", "customType": "BatchJobStatusV1", "schema": [ { "name": "status", "kind": "required", "type": "string", "description": "Terminal status of the job. While the job is still running the endpoint instead responds 202 with this field set to pending or processing.", "example": "complete", "enum": [ "complete", "failed" ] }, { "name": "accepted", "kind": "optional", "type": "integer", "description": "Number of events accepted. Present when status is complete.", "example": 950, "format": "int32" }, { "name": "rejected", "kind": "optional", "type": "integer", "description": "Number of events rejected. Present when status is complete.", "example": 50, "format": "int32" }, { "name": "errors", "kind": "optional", "type": "array", "description": "

Per-item validation errors, indexed to each event's position in the batch. Capped at 10,000 entries; see the truncation fields below.

", "modelRef": "#/definitions/BatchJobError", "customType": "BatchJobError[]", "schema": [ { "name": "index", "kind": "required", "type": "integer", "description": "

0-based position of the event within the submitted batch.

", "example": 41, "format": "int32" }, { "name": "field", "kind": "optional", "type": "string", "description": "

The event field that failed validation, when the error is field-specific.

", "example": "contactMethod" }, { "name": "error", "kind": "required", "type": "string", "description": "

Human-readable description of the problem.

", "example": "contactMethod does not have a valid value" } ] }, { "name": "errors_truncated", "kind": "optional", "type": "boolean", "description": "

True when there were more than 10,000 errors and the inline list was capped to the first 10,000; the full list is then available at the errors url.

" }, { "name": "errors_url", "kind": "optional", "type": "string", "description": "

Signed, 24-hour URL to the complete errors list when the inline list was truncated; null otherwise.

", "example": "https://storage.googleapis.com/.../errors.json", "format": "uri" }, { "name": "error", "kind": "optional", "type": "string", "description": "Failure reason. Present when status is failed.", "example": "Uploaded object is missing." } ], "modelRef": "#/definitions/BatchJobStatusV1", "isExpanded": true } ] }, { "statusCode": "202", "description": "Job still running.", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Not found", "jsonExample": "", "isExpanded": true } ], "examples": { "languages": [ { "id": "kUPMj1y6SB3_EH1FaGdCL", "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.throughlinecare.com/v1/events/batch/jobs/{jobId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "tv20qhBkvXYYAUp7cd9y-", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.throughlinecare.com/v1/events/batch/jobs/{jobId}\")\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": "zG036VusC3rCziu69DNXJ", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.throughlinecare.com/v1/events/batch/jobs/{jobId}\"\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" }, { "id": "B0g7WI_wWgoV7GzbPj2Ob", "language": "java", "label": "Java", "code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"https://api.throughlinecare.com/v1/events/batch/jobs/{jobId}\")\n .method(\"GET\", body)\n .addHeader(\"accept\", \"application/json\")\n .addHeader(\"content-type\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" }, { "id": "fYld_BK2ubd-K9v7VjOnK", "language": "swift", "label": "Swift", "code": "var request = URLRequest(url: URL(string: \"https://api.throughlinecare.com/v1/events/batch/jobs/{jobId}\")!,timeoutInterval: Double.infinity)\nrequest.addValue(\"application/json\", forHTTPHeaderField: \"accept\")\nrequest.addValue(\"application/json\", forHTTPHeaderField: \"content-type\")\n\nrequest.httpMethod = \"GET\"\n\nlet task = URLSession.shared.dataTask(with: request) { data, response, error in \n guard let data = data else {\n print(String(describing: error))\n return\n }\n print(String(data: data, encoding: .utf8)!)\n}\n\ntask.resume()\n" } ], "selectedLanguageId": "kUPMj1y6SB3_EH1FaGdCL" }, "results": { "languages": [ { "id": "_d8gXFm29UjPZTVQf7spS", "language": "200", "code": "// Job complete.\n{\n \"status\": \"complete\",\n \"accepted\": 950,\n \"rejected\": 50,\n \"errors\": [\n {\n \"index\": 41,\n \"field\": \"contactMethod\",\n \"error\": \"contactMethod does not have a valid value\"\n }\n ],\n \"errors_truncated\": false,\n \"errors_url\": \"https://storage.googleapis.com/.../errors.json\",\n \"error\": \"Uploaded object is missing.\"\n}" }, { "id": "cV4tBsPTT5gnY7v5OJIwy", "language": "202", "code": "// Job still running.\n" }, { "id": "ahe-eEf34-G78ZBzvoqiz", "language": "401", "code": "// Unauthorized\n" }, { "id": "F6iWomEuJcHi84hicZR22", "language": "404", "code": "// Not found\n" } ], "selectedLanguageId": "_d8gXFm29UjPZTVQf7spS" } }, "children": [ { "text": "" } ] }