1. Partner API v2
  2. Resources
  3. Phishing

Phishing

Simulation results, summaries, and the templates a client's simulations use.
4 endpointsScope readPhishingResultPhishingSummaryPhishingTemplate
GET/v2/users/{user_id}/phishing

List a user's phishing simulation resultsLink to this endpoint

RequiresreadscopeCursor-paginatedReturns Page of PhishingResult

Path parameters

user_idstringRequired

User id (the user's INFIMA id).

Query parametersall optional unless marked

sincestring (date-time)

Only records at or after this time (RFC 3339).

untilstring (date-time)

Only records before this time (RFC 3339).

statusstring

The furthest a simulation got. Statuses are ordered; reported is the good outcome.

One ofsentopenedclickedreportedcredentials_submittedattachment_opened
limitinteger

Default 100min 1 · max 500

cursorstring

Opaque cursor from the previous page's page.next_cursor.

curl "https://app.infimasecapis.com/v2/users/b7e1c0d2-44aa-5f9e-8c33-1a2b3c4d5e6f/phishing" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPage of PhishingResult
dataarray of PhishingResult
Show item properties(13)
user_idstring
client_idstring
templateobject
Show properties(3)
idstring
namestring
categorystring
statusstring

The furthest a simulation got. Statuses are ordered; reported is the good outcome.

One ofsentopenedclickedreportedcredentials_submittedattachment_opened
sent_atstring (date-time)
opened_atstring (date-time)Nullable
clicked_atstring (date-time)Nullable
reported_atstring (date-time)Nullable
credentials_submitted_atstring (date-time)Nullable
attachment_opened_atstring (date-time)Nullable
originstringNullable

experiment when the send was part of a phishing experiment; null for every other send. Open enum: values for scheduled and on-demand sends may be added later.

One ofexperiment
remediationobjectNullable

Present when a click triggered behavior training.

Show properties(2)
course_idstring
statusstring

upcoming = start date in the future; open = started, not yet due; overdue = past due without completion; completed = passed.

One ofupcomingopenoverduecompleted
updated_atstring (date-time)
pageobject
Show properties(2)
next_cursorstringNullable

Pass as cursor to fetch the next page. Null on the last page.

has_moreboolean
GET/v2/clients/{client_id}/phishing/summary

Get a client's phishing summaryLink to this endpoint

RequiresreadscopeReturns PhishingSummary

Counts and rates for a window. Use window=30d for a monthly report, 365d for a trailing year.

Path parameters

client_idstringRequired

Client id (the client's INFIMA id).

Query parametersall optional unless marked

windowstring
One of30d90d365dall

Default "90d"

curl "https://app.infimasecapis.com/v2/clients/3f2a9c1e-7b44-5d2e-9a1f-0c6d8e4b2a10/phishing/summary" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPhishingSummary
client_idstring
windowstring
sentinteger
openedinteger
clickedinteger
reportedinteger
credentials_submittedinteger
attachments_openedinteger
click_ratenumber (float)
report_ratenumber (float)
users_targetedinteger
repeat_clickersinteger

Users who clicked more than once in the window.

computed_atstring (date-time)
GET/v2/clients/{client_id}/phishing/results

List phishing simulation resultsLink to this endpoint

RequiresreadscopeCursor-paginatedReturns Page of PhishingResult

One record per simulated email sent to a user in the client, with its current outcome. For an event feed, poll with updated_since: a record's updated_at changes each time its status advances (opened, clicked, reported).

Path parameters

client_idstringRequired

Client id (the client's INFIMA id).

Query parametersall optional unless marked

sincestring (date-time)

Only records at or after this time (RFC 3339).

untilstring (date-time)

Only records before this time (RFC 3339).

updated_sincestring (date-time)

Only objects whose updated_at is at or after this time. Use it for delta syncs.

statusstring

Comma-separated statuses.

user_idstring
limitinteger

Default 100min 1 · max 500

cursorstring

Opaque cursor from the previous page's page.next_cursor.

curl "https://app.infimasecapis.com/v2/clients/3f2a9c1e-7b44-5d2e-9a1f-0c6d8e4b2a10/phishing/results" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPage of PhishingResult
dataarray of PhishingResult
Show item properties(13)
user_idstring
client_idstring
templateobject
Show properties(3)
idstring
namestring
categorystring
statusstring

The furthest a simulation got. Statuses are ordered; reported is the good outcome.

One ofsentopenedclickedreportedcredentials_submittedattachment_opened
sent_atstring (date-time)
opened_atstring (date-time)Nullable
clicked_atstring (date-time)Nullable
reported_atstring (date-time)Nullable
credentials_submitted_atstring (date-time)Nullable
attachment_opened_atstring (date-time)Nullable
originstringNullable

experiment when the send was part of a phishing experiment; null for every other send. Open enum: values for scheduled and on-demand sends may be added later.

One ofexperiment
remediationobjectNullable

Present when a click triggered behavior training.

Show properties(2)
course_idstring
statusstring

upcoming = start date in the future; open = started, not yet due; overdue = past due without completion; completed = passed.

One ofupcomingopenoverduecompleted
updated_atstring (date-time)
pageobject
Show properties(2)
next_cursorstringNullable

Pass as cursor to fetch the next page. Null on the last page.

has_moreboolean
GET/v2/clients/{client_id}/phishing/templates

List phishing templates enabled for a clientLink to this endpoint

RequiresreadscopeCursor-paginatedReturns Page of PhishingTemplate

The templates the client's users can receive, so you can pick one for an on-demand send. Content is not included.

Path parameters

client_idstringRequired

Client id (the client's INFIMA id).

Query parametersall optional unless marked

categorystring
localestring
One ofenesfr-ca
limitinteger

Default 100min 1 · max 500

cursorstring

Opaque cursor from the previous page's page.next_cursor.

curl "https://app.infimasecapis.com/v2/clients/3f2a9c1e-7b44-5d2e-9a1f-0c6d8e4b2a10/phishing/templates" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPage of PhishingTemplate
dataarray of PhishingTemplate
Show item properties(7)
idstring

The template's id, shared by its translations. A client's own templates without one have no id.

namestring
subjectstring
categorystring
localestring
One ofenesfr-ca
difficultystringNullable
One ofeasymediumhard
ownerstring
One ofinfimapartnerclient
pageobject
Show properties(2)
next_cursorstringNullable

Pass as cursor to fetch the next page. Null on the last page.

has_moreboolean
Coming in 2.x2 more Phishing operations are specified for a later 2.x release.See the roadmap