Jobs

List verification jobs

Newest first. total counts every job matching the listing, not just the page. Paginate on has_more and next_offset.

total_is_approximate: true means the count stopped at its scan bound, so total is a floor.

get/v1/jobs

Request

  • Base URL: https://api.kawaa.com
  • URL: https://api.kawaa.com/v1/jobs
  • Auth: one of:
    • API key in header X-Api-Key
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.kawaa.com/oauth/authorize, token URL https://api.kawaa.com/oauth/token, scopes: verification:read)

Query parameters

limitinteger

Page size, 1 to 100. A malformed, fractional, zero, negative or larger value is a 400 rather than silently clamped. Every response echoes the page size it applied.

status'pending' | 'processing' | 'completed' | 'failed' | 'cancelled' | 'enqueue_unknown'

Return only jobs in this state. cancelled is a real equality filter like any other value, and now returns the jobs stopped through POST /v1/jobs/{id}/cancel.

offsetstring

The next_offset from the previous page. Opaque; do not construct one. A value that does not decode or is not in the shape this endpoint issues is a 400 with code INVALID_CURSOR; start again without it. An empty offset= is read as no offset, the first page.

type'batch'

Return batch and uploaded-file jobs, including legacy bulk and file job labels. Omit this filter to include single-address verifications. Any other present value returns HTTP 400.

Response

A page of jobs.

successunknown required

Example response

{
  "data": {
    "jobs": [
      {
        "results": [
          {
            "sub_status": "mailbox_exists",
            "ai": {
              "typo_method": "DirectMapping"
            },
            "suggestion": "jane@gmail.com"
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.