1. Partner API v2
  2. Resources
  3. Users

Users

The people enrolled in a client's program.
2 endpointsScope readUserUserDetail
GET/v2/clients/{client_id}/users

List users in a clientLink to this endpoint

RequiresreadscopeCursor-paginatedReturns Page of User

Defaults to active users. Each user carries a compact risk and training summary; use GET /users/{user_id} for the full breakdown.

Path parameters

client_idstringRequired

Client id (the client's INFIMA id).

Query parametersall optional unless marked

statusstring
One ofactiveinactiveall

Default "active"

rolestring

The role used to weight a user's risk signals.

One ofadminexecutivehrfinancestandard
emailstring (email)

Exact, case-insensitive email match. The fastest way to look a user up.

qstring

Case-insensitive match on name or email.

collection_idstring

Only members of this collection.

group_idstring

Only members of this directory group. Not available yet (directory groups do not have ids in this version); sending it returns 400.

updated_sincestring (date-time)

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

sortstring
One ofemail-emaillast_name-last_namerisk_score-risk_scorecreated_at-created_at

Default "email"

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/users" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPage of User
dataarray of User
Show item properties(17)
idstring
client_idstring
emailstring (email)
first_namestring
last_namestring
departmentstringNullable
job_titlestringNullable
manager_emailstring (email)Nullable
statusstring
One ofactiveinactive
rolestring

The role used to weight a user's risk signals.

One ofadminexecutivehrfinancestandard
preferred_languagestring
One ofenesfr-ca
sourcestring

Where the user record came from.

One ofmicrosoftgooglemanualapi
groupobjectNullable

The directory group or manual group the user belongs to.

Show properties(2)
idstring
namestring
riskobject
Show properties(2)
scoreinteger
gradestring

Letter grade derived from the score. A is 800 and above, B 700, C 600, D 400, F below 400.

One ofABCDF
trainingobject
Show properties(3)
on_trackboolean
overdue_countinteger
next_courseobjectNullable
Show properties(3)
course_idstring
titlestring
due_onstring (date)
created_atstring (date-time)
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/users/{user_id}

Get a userLink to this endpoint

RequiresreadscopeReturns UserDetail

Full user record including the risk breakdown and current training position.

Path parameters

user_idstringRequired

User id (the user's INFIMA id).

curl "https://app.infimasecapis.com/v2/users/b7e1c0d2-44aa-5f9e-8c33-1a2b3c4d5e6f" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectUserDetail
idstring
client_idstring
emailstring (email)
first_namestring
last_namestring
departmentstringNullable
job_titlestringNullable
manager_emailstring (email)Nullable
statusstring
One ofactiveinactive
rolestring

The role used to weight a user's risk signals.

One ofadminexecutivehrfinancestandard
preferred_languagestring
One ofenesfr-ca
sourcestring

Where the user record came from.

One ofmicrosoftgooglemanualapi
groupobjectNullable

The directory group or manual group the user belongs to.

Show properties(2)
idstring
namestring
riskUserRisk
Show properties(7)
scoreinteger
gradestring

Letter grade derived from the score. A is 800 and above, B 700, C 600, D 400, F below 400.

One ofABCDF
baselineinteger

The starting score for the user's role before signals are applied.

rolestring

The role used to weight a user's risk signals.

One ofadminexecutivehrfinancestandard
talliesobject

Raw counts over the trailing 12 months. The score applies recency weighting internally.

Show properties(11)
courses_completedinteger
phishing_clicksinteger
phishing_reportsinteger
credential_submissionsinteger
attachments_openedinteger
real_phish_reportedinteger
password_breaches_activeinteger
password_breaches_resolvedinteger
pii_breachesinteger
basic_breachesinteger
dormant_on_trainingboolean
factorsarray of object

Each signal's signed contribution, role multiplier applied.

Show item properties(3)
keystring
labelstring
deltainteger
computed_atstring (date-time)
trainingobject
Show properties(3)
on_trackboolean
overdue_countinteger
next_courseobjectNullable
Show properties(3)
course_idstring
titlestring
due_onstring (date)
created_atstring (date-time)
updated_atstring (date-time)
collectionsarray of object
Show item properties(2)
idstring
namestring
dark_webobjectNullable

Null when Dark Web Monitoring is not enabled for the client.

Show properties(3)
unresolved_exposuresinteger
resolved_exposuresinteger
highest_severitystring

critical = passwords exposed; high = sensitive personal data; medium = basic account data; low = spam lists.

One ofcriticalhighmediumlow
Errors404Not found within the key's accessError envelope →
Coming in 2.x2 more Users operations are specified for a later 2.x release.See the roadmap