List Bulk Geocode Jobs

Developing

GET

/api/v1/public/geocode/bulk

Returns every bulk geocode job submitted by your company, newest first, each with its per-row totals for processed and failed addresses. The list is not paginated, so it grows with your submission history.

Request

Authorization

API Key

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Responses

🟢200

application/json

Jobs returned, newest first. An empty array when none have been submitted.

Bodyapplication/json

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/public/geocode/bulk' \
--header 'X-Api-Key: <api-key>'

Response Example

200 - Example 1

{
    "status": true,
    "message": "Operation successful.",
    "data": [
        {
            "bulkRef": "f167f2c8-a214-41f6-b5ed-298b411ca68e",
            "jobStatus": "pending",
            "dateCreated": "2019-08-24T14:15:22.123Z",
            "createdBy": "string",
            "totalItems": 150,
            "doneItems": 148,
            "failedItems": 2
        }
    ]
}

Modified at 2026-08-06 11:58:31

Submit A Bulk Geocode Job

Get A Bulk Geocode Job