1. Partner API v2
  2. Resources
  3. Training

Training

Curriculum, course catalog, and course assignments.
4 endpointsScope readTrainingAssignmentCourseCurriculumItem
GET/v2/users/{user_id}/training
RequiresreadscopeCursor-paginatedReturns Page of TrainingAssignment

Every course assigned to the user with its status, dates, and where the assignment came from.

Path parameters

user_idstringRequired

User id (the user's INFIMA id).

Query parametersall optional unless marked

statusstring

upcoming = start date in the future; open = started, not overdue; overdue = not completed by the end of the due date (it is overdue from the next day, UTC), except that a phishing-remediation (behavior) assignment is only overdue while the client requires that training and is otherwise open; completed = passed.

One ofupcomingopenoverduecompleted
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/training" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPage of TrainingAssignment
dataarray of TrainingAssignment
Show item properties(10)
user_idstring
courseobject
Show properties(2)
idstring
titlestring
statusstring

upcoming = start date in the future; open = started, not overdue; overdue = not completed by the end of the due date (it is overdue from the next day, UTC), except that a phishing-remediation (behavior) assignment is only overdue while the client requires that training and is otherwise open; completed = passed.

One ofupcomingopenoverduecompleted
sourcestring

Why the course was assigned. Open enum; new sources may be added.

One offrameworkadaptivemanualbehavioronboardingapi
framework_idstringNullable

Set when source is framework.

start_onstring (date)
due_onstring (date)
completed_atstring (date-time)Nullable
scoreintegerNullable

Quiz score percentage when the course has a quiz.

certificate_urlstringNullable

Signed link to the completion certificate, when one exists.

pageobject
Show properties(2)
next_cursorstringNullable

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

has_moreboolean
GET/v2/courses
RequiresreadscopeCursor-paginatedReturns Page of Course

Courses available to your partner account, including your own custom courses.

Query parametersall optional unless marked

categorystring
qstring
limitinteger

Default 100min 1 · max 500

cursorstring

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

curl "https://app.infimasecapis.com/v2/courses" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPage of Course
dataarray of Course
Show item properties(7)
idstring

The course slug.

titlestring
categorystring
descriptionstring
duration_minutesintegerNullable
languagesarray of string
Each one ofenesfr-ca
ownerstring

Whether it is a stock course or one your partner account created.

One ofinfimapartner
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}/training/curriculum
RequiresreadscopeCursor-paginatedReturns Page of CurriculumItem

The courses scheduled for the client, grouped by audience, with completion percentage and where each course came from (framework, adaptive, manual).

Path parameters

client_idstringRequired

Client id (the client's INFIMA id).

Query parametersall optional unless marked

statusstring

upcoming = start date in the future; open = started, not overdue; overdue = not completed by the end of the due date (it is overdue from the next day, UTC), except that a phishing-remediation (behavior) assignment is only overdue while the client requires that training and is otherwise open; completed = passed.

One ofupcomingopenoverduecompleted
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/training/curriculum" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPage of CurriculumItem
dataarray of CurriculumItem
Show item properties(10)
courseobject
Show properties(2)
idstring
titlestring
audienceobject

Who the course is scheduled for.

Show properties(3)
typestring
One ofallgroupcollectionusers
idstringNullable
namestringNullable
sourcestring

Why the course was assigned. Open enum; new sources may be added.

One offrameworkadaptivemanualbehavioronboardingapi
framework_idstringNullable
statusstring

upcoming = start date in the future; open = started, not overdue; overdue = not completed by the end of the due date (it is overdue from the next day, UTC), except that a phishing-remediation (behavior) assignment is only overdue while the client requires that training and is otherwise open; completed = passed.

One ofupcomingopenoverduecompleted
start_onstring (date)
due_onstring (date)
assigned_countinteger
completed_countinteger
completion_ratenumber (float)
pageobject
Show properties(2)
next_cursorstringNullable

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

has_moreboolean
POST/v2/clients/{client_id}/training/assignments
Requireswritescope

Assigns a course to the whole client, a collection, or specific users, with a due date, the way the dashboard's Assign course page does: one manual assignment per audience, locked so the automatic curriculum never moves it. The use case we have in mind: a SOC or PSA workflow assigns targeted remediation after a real incident.

  • course_id is an id from GET /courses, and the course must be available to the client; otherwise 400.
  • due_on defaults to 30 days from today. The course starts today, or on due_on when that is earlier.
  • A completion dated inside the assignment's window (from its start date to a year past the due date) counts: that user keeps it and is listed in skipped as already_completed. Older completions do not count, so a user who took the course last year is assigned it again, as the dashboard does. Inactive users are inactive. With audience.type users, a user who already has this exact assignment is already_assigned. For the whole client or a collection that already has it, the response is 409 and nothing changes.
  • notify sends each assigned user the course invitation email now; with false the normal reminder cadence picks them up.

Send an Idempotency-Key: a retried request replays the original 201 instead of creating a second assignment.

Path parameters

client_idstringRequired

Client id (the client's INFIMA id).

Request bodyapplication/json

course_idstringRequired
audienceAudienceRequired

Who an action applies to. Exactly one of the shapes.

Show properties(3)
typestringRequired
One ofallcollectionusers
collection_idstring

Required when type is collection.

user_idsarray of string

Required when type is users.

due_onstring (date)

Due date, today or later where the caller is (any date from yesterday UTC on is accepted). Defaults to 30 days from today.

notifyboolean

Email each assigned user the course invitation now.

Default true

curl -X POST "https://app.infimasecapis.com/v2/clients/3f2a9c1e-7b44-5d2e-9a1f-0c6d8e4b2a10/training/assignments" \
  -H "X-API-Key: $INFIMA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "course_id": "phishing-fundamentals",
    "audience": {
      "type": "all",
      "collection_id": "6f1c2a7e-3b9d-4c1a-9e8f-0a1b2c3d4e5f",
      "user_ids": [
        "b7e1c0d2-44aa-5f9e-8c33-1a2b3c4d5e6f"
      ]
    },
    "due_on": "2026-10-31",
    "notify": true
  }'
Response objectObject
course_idstring
assigned_countinteger

Users who now have the course to do.

due_onstring (date)
skippedarray of object

Users in the audience who were not given the course, and why.

Show item properties(2)
user_idstring
reasonstring

Open enum; new reasons may be added.

One ofalready_completedinactivealready_assigned
Errors400Invalid request409The object already existsError envelope →