API Reference

List Campaigns

get
https://api.doppel.com/v1/hrm/campaigns

List phishing simulation campaigns for the authenticated organization. Supports filtering by status, campaign type, date range, and test flag. Returns paginated results.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Headers
string

(optional) Your Doppel Organization Code. Required if user is in multiple organizations.

Query Params
string

Filter by campaign status (e.g. pending, in_progress, finished)

string

Filter by campaign type (e.g. simulation)

string

Filter campaigns launched after this ISO 8601 date

string

Filter campaigns launched before this ISO 8601 date

boolean
Defaults to false

Include test campaigns (defaults to false)

string
Defaults to created_at

Sort field: launch_date, created_at, or name

string
Defaults to desc

Sort order: asc or desc

integer
1 to 1000
Defaults to 100

Maximum number of results to return

integer
≥ 0
Defaults to 0

Number of results to skip for pagination

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?