Skip to main content
GET
/
service
/
v2
/
bulk-search
/
{job_id}
Get Bulk Search Job Status
curl --request GET \
  --url https://oathnet.org/api/service/v2/bulk-search/{job_id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "job_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "progress": {
    "records_done": 123,
    "records_total": 123,
    "bytes_done": 123,
    "percent": 123,
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "result": {
    "format": "<string>",
    "file_name": "<string>",
    "file_path": "<string>",
    "file_size": 123,
    "records": 123,
    "ready_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z"
  },
  "last_error": "<string>",
  "request": {
    "type": "<string>",
    "service": "<string>",
    "format": "<string>",
    "limit": 123,
    "fields": [
      "<string>"
    ],
    "request_count": 123
  },
  "next_poll_after_ms": 123,
  "metadata": {}
}
Return the current raw job snapshot for one owned bulk-search job.

Authorizations

​
x-api-key
string
header
required

API key for authentication (lowercase header name)

Path Parameters

​
job_id
string
required

Response

Raw bulk-search job snapshot

​
id
string
​
job_id
string
​
status
enum<string>
Available options:
queued,
running,
completed,
canceled
​
created_at
string<date-time>
​
started_at
string<date-time>
​
completed_at
string<date-time>
​
expires_at
string<date-time>
​
progress
object
​
result
object
​
last_error
string
​
request
object
​
next_poll_after_ms
integer
​
metadata
object