Skip to main content
GET
List Custom Link jobs
Requires custom_links:read or custom_links:write. Use this endpoint to recover job ids after a client restart. Poll one job for current counters and fetch its items only when the counters change.

Authorizations

Authorization
string
header
required

Hobbes API key with the hb_live_ prefix.

Query Parameters

status
enum<string> | null
Available options:
queued,
processing,
completed,
completed_with_errors,
cancelled,
failed
campaign_id
string<uuid> | null

Custom Link campaign UUID.

date_from
string<date-time> | null
date_to
string<date-time> | null
limit
integer
default:50

Number of records to return. Defaults to 50 and cannot exceed 200.

Required range: 1 <= x <= 200
offset
integer
default:0

Zero-based number of records to skip. Use with pagination.total to request the next page.

Required range: 0 <= x <= 1000000

Response

Successful Response

jobs
CustomLinkJobResponse · object[]
required
total
integer
required
limit
integer
required
offset
integer
required