GET
Every client the key can access, with a summary of user counts, risk, training, phishing, and enabled features. Summaries are computed on request and cached for a few minutes; call this once per sync run, not once per user.
Query parametersall optional unless marked
idsstringComma-separated client ids to restrict the list to.
qstringCase-insensitive match on client name.
updated_sincestring (date-time)Only objects whose updated_at is at or after this time. Use it for delta syncs.
sortstringOne of
name-namecreated_at-created_atrisk_score-risk_scoreDefault "name"
limitintegerDefault 100min 1 · max 500
cursorstringOpaque cursor from the previous page's page.next_cursor.
curl "https://app.infimasecapis.com/v2/clients" \
-H "X-API-Key: $INFIMA_API_KEY"Response objectPage of Client
dataarray of ClientShowHide item properties(12)
idstringnamestringindustrystringNullableexternal_idstringNullablecreated_atstring (date-time)updated_atstring (date-time)usersobjectShowHide properties(2)
activeintegerinactiveintegerriskobjectShowHide properties(3)
average_scoreintegergradestringLetter grade derived from the score. A is 800 and above, B 700, C 600, D 400, F below 400.
One of
ABCDFhigh_risk_usersintegerUsers graded D or F.
trainingobjectShowHide properties(2)
on_track_ratenumber (float)Percentage of active users with no overdue course.
overdue_usersintegerphishingobjectShowHide properties(2)
click_rate_90dnumber (float)report_rate_90dnumber (float)frameworksarray of stringIds of frameworks assigned to the client.
featuresobjectShowHide properties(2)
dark_web_monitoringbooleandirectory_syncstringNullableOne of
microsoftgooglepageobjectShowHide properties(2)
next_cursorstringNullablePass as cursor to fetch the next page. Null on the last page.
has_moreboolean