Bulk Geo Addressing Service: Get Job list Request And Response - Precisely Data Integrity Suite

Data Integrity Suite APIs
Product
Data_Integrity
Spatial_Analytics
Data_Enrichment
geo_addressing_1
Services
Spatial Analytics
Data Enrichment
Geo Addressing
ft:title
Data Integrity Suite APIs
ft:locale
en-US
PublicationType
pt_developer
copyrightfirst
2023
copyrightlast
2026

GET https://hostname/v1/bulk/jobs

Request

Query parameters

Key Required Type Description
status No string Filter jobs by status. Allowed values: 'scheduled', 'running', or 'all'. If not provided, returns all jobs.

Header keys

Table 1.
Key Required Type Description
X-Request-Id No string The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting.

Response

The API returns a JSON object containing a list of bulk geocode/verify jobs associated with the authenticated user. Each job entry includes metadata describing the job's identity, source file, status, and submission timestamp.

Response body properties

Table 2.
Property Type Description
jobId String Unique identifier for the job
emailId String Email address of the user who submitted the job.
fileId String Identifier of the uploaded file associated with the job
fileName String Name of the uploaded file
status String

Current processing status of the job (e.g., SCHEDULED, RUNNING).
submittedAt String Timestamp indicating when the job was submitted.

Response examples

Example status code responses for this method are shown here.

Examples
{
  "jobs": [
    {
      "jobId": "bd80fe36-d7f4-4bc8-b1a2-4d25c04f842e",
      "emailId": "sample_user@precisely.com",
      "fileId": "bb1cef64-1fb1-4433-a440-e62252cd2fe8",
      "fileName": "SampleFile",
      "status": "SCHEDULED",
      "submittedAt": "2025-11-03T09:39:17.128Z"
    },
    {
      "jobId": "617c3dbb-4c56-4ec7-a9cb-962450a3022e",
      "emailId": "sample_user@precisely.com",
      "fileId": "bb1cef64-1fb1-4433-a440-e62252cd2fe8",
      "fileName": "SampleFile",
      "status": "RUNNING",
      "submittedAt": "2025-11-03T09:39:10.849Z"
    }
  ]
}
 
{
  "errors": [
    {
      "status": "INVALID_CLIENT_INPUT",
      "errorMessage": "Request is not valid (DIS-LI-1018)"
    }
  ]
}
 
{
  "errors": [
    {
      "status": "INVALID_TOKEN",
      "errorMessage": "Unauthorized (DIS-1001)"
    }
  ]
}
 
{
  "errors": [
    {
      "status": "FORBIDDEN",
      "errorMessage": "You do not have permission to access this API (DIS-1002)"
    }
  ]
}
 
{
  "errors": [
    {
      "status": "TOO_MANY_REQUESTS",
      "errorMessage": "Rate limit exceeded (DIS-1005)"
    }
  ]
}
 
{
  "errors": [
    {
      "status": "INTERNAL_ERROR",
      "errorMessage": "Issue with internal services. Please try again after sometime (DIS-1003)"
    }
  ]
}