1. Partner API v2
  2. Resources
  3. Emails

Emails

Emails INFIMA has sent to a user (welcome, reminders, phishing simulations).
1 endpointScope readSentEmail
GET/v2/users/{user_id}/emails
RequiresreadscopeCursor-paginatedReturns Page of SentEmail

Every email INFIMA has sent to the user: welcome emails, training reminders, phishing simulations, breach notifications. Useful for support ("did they get the reminder?") and for deliverability checks. Defaults to the last 30 days.

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).

typestring

Comma-separated message types.

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/emails" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPage of SentEmail
dataarray of SentEmail
Show item properties(6)
user_idstring
typestring

Open enum.

One ofwelcometraining_remindertraining_assignmentphishingbreach_notificationpolicy_remindercertificate
subjectstring
fromstring (email)
sent_atstring (date-time)
deliverystring

How it was delivered. graph and gmail mean direct mailbox delivery through the client's directory integration.

One ofsmtpgraphgmail
pageobject
Show properties(2)
next_cursorstringNullable

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

has_moreboolean