Skip to main content
GET
cURL

Authorizations

api-key
string
header
required

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Headers

X-Profile-Id
string | null

Restricts the listing to jobs run for this business profile, plus jobs that predate profile scoping. When no profile can be resolved, all of the merchant's jobs are returned, as before.

X-Connected-Merchant-Id
string | null

Merchant ID of the connected merchant on whose behalf the operation is performed. Required when authenticating with a platform merchant's API key. Standard and connected merchants must not send it.

Query Parameters

limit
integer<int32> | null

Maximum number of jobs to return (default 10, max 100)

Required range: x >= 0
offset
integer<int32> | null

Zero-based offset for pagination (default 0)

Required range: x >= 0
job_type
enum<string> | null

Restricts the listing to upload, export, or profile_clone jobs. All kinds are returned when omitted, newest first. Distinguishes bulk upload, CSV export, and profile clone jobs.

Available options:
upload,
export,
profile_clone

Response

200 - application/json

List of batch blocklist jobs. Rows report downloadable, but never download_url - fetch the link from GET /blocklist/batch/{job_id} when the merchant asks for that specific file.

Response for GET /blocklist/batch.

count
integer
required
Required range: x >= 0
total_count
integer
required
Required range: x >= 0
data
object[]
required