Skip to content

GET Async Batch Job Details enterprise only

Note

This is a synchronous call that retrieves detailed information about a specific batch job.

The batch job details service allows you to retrieve comprehensive information about a specific batch geocoding job, including status, timestamps, record counts, and result URLs.

Resource URL

https://www.mapquestapi.com/geocoding/v1/batch/jobs/{jobId}

Resource Information

Response FormatsJSON
AuthenticationYes (Requires Key)
Rate LimitedYes

Request Parameters

Request ParameterDescriptionRequired
keyThe API Key, which is needed to make requests to MapQuest services.Yes

Note: The jobId is specified in the URL path, not as a query parameter.

Response Object

idThe unique job identifier
statusThe current job status
hrefThe MapQuest URL of the job details
createdISO timestamp when the job was created
startedISO timestamp when the job was started
endedISO timestamp when the job ended
recordsRecord counts for the job
records.totalTotal number of records in the job
records.validNumber of valid records
records.invalidNumber of invalid records
records.processedNumber of processed records
records.pendingNumber of pending records
records.succeededNumber of succeeded records
records.failedNumber of failed records
resultsHrefURL to retrieve job results (empty if not available)
errorsHrefURL to retrieve job errors (empty if no errors)
outputTypeThe output format type for the job (currently only "csv" is supported)

Example Request

bash
curl -X GET "https://www.mapquestapi.com/geocoding/v1/batch/jobs/abc123-def456-ghi789?key=YOUR_API_KEY"

Example Response

json
{
    "id": "abc123-def456-ghi789",
    "status": "completed",
    "href": "https://www.mapquestapi.com/geocoding/v1/batch/jobs/abc123-def456-ghi789",
    "created": "2025-09-07T22:17:15.870404Z",
    "started": "2025-09-07T22:18:03.829643Z",
    "ended": "2025-09-07T22:18:12.557219Z",
    "records": {
        "total": 3,
        "valid": 3,
        "invalid": 0,
        "processed": 3,
        "pending": 0,
        "succeeded": 3,
        "failed": 0
    },
    "resultsHref": "https://www.mapquestapi.com/geocoding/v1/batch/jobs/abc123-def456-ghi789/results",
    "errorsHref": "",
    "outputType": "csv"
}

Job Status Values

StatusDescription
submittedJob has been received and submitted
queuedJob is queued and waiting to be processed
pendingJob is pending processing
inProgressJob is currently being processed
completedJob has finished processing successfully
stoppedJob has been stopped
failureJob failed due to an error

Important Notes

  • Blocking Call: This is a synchronous request that returns immediately with current job status
  • Authentication: Same API key as other endpoints, passed as query parameter
  • Job ID: The job ID is passed in the URL path, not as a query parameter
  • Timestamps: All timestamps are in ISO 8601 format with UTC timezone
  • Record Counts: Use the records object to track processing progress
  • Result URLs: Use resultsHref to retrieve results when job is completed
  • Error Handling: Check errorsHref for error details if the job failed