Skip to content

List people due for recertification

GET/v1/organization/{orgId}/learning/workspace/engagement/recertification

US Region: https://public-api.sessionboard.com · EU Region: https://public-api-eu.sessionboard.com

People whose certification expires within withinDays, or lapsed in the last 90 days and has not been renewed, soonest first (up to 500), each with the next course that counts toward renewal. Reads only. Requires read:learning; refused for a key restricted to particular events. Also at GET /v1/learning/workspace/engagement/recertification.

Request example

Terminal window
curl --request GET \
--url 'https://public-api.sessionboard.com/v1/organization/{orgId}/learning/workspace/engagement/recertification' \
--header 'x-access-token: <api-token>'

Try it

Authorization

Your token stays in this page. It is sent only to the region above and is never saved; it is gone when you leave or reload the page.

Path parameters
Query parameters
GET

Authorizations

  • x-access-tokenstringheader

    Organization API token. Generate from Organization Settings → API Tokens.

  • AuthorizationBearer <token>headeror

    OAuth 2.1 access token. Obtained via the OAuth PKCE flow at /oauth/token.

Send one of these. See Authentication.

Path parameters

  • orgIdstringpathrequired

    Your organization ID. Any other organization returns 404.

Query parameters

  • withinDaysintegerquery
    Default
    30
    Minimum
    1
    Maximum
    365

Responses

200application/json

OK

  • successboolean
  • payloadobject
    Show child attributes
    • within_daysinteger
    • totalinteger
    • peopleLearningRecertificationPerson[]
      Show child attributes
      • person_idstring<uuid>
      • namestring
      • emailstring
      • certificationstring
      • certification_idstring<uuid>
      • expires_atstring<date-time>
      • days_leftinteger

        Zero or negative once lapsed.

      • expiredboolean
      • next_lessonLearningNextLesson | any | null
        Show child attributes
        • lesson_idstring<uuid>
        • content_idstring
        • titlestring
        • kindstring
        • minutesinteger | null
        • creditobject[]
          Show child attributes
          • type_idstring<uuid> | null
          • namestring | null
          • amountnumber
        • eventstring | null
        • sessionstring | null
        • reasonstring
          Allowed values
          "renewal", "continue", "attended", "topic", "credit", "popular"
        • becausestring
        • rankinteger
        • earns_creditboolean

          attended only.

    • summarystring

400application/json

A path, query or body value failed validation, or an unknown body property was sent. message names the field. (A source object naming the assistant, with the person's prompt, is accepted on every write and removed before validation.) For an {eventId} path that is not a whole number: error: VALIDATION_ERROR, eventId must be a valid integer.

Gateway errors carry error (a code) and message. Errors from Learning itself carry status, success: false, message, name, and sometimes code (and feature or paused_at).

  • errorstring | object

    The gateway's error code (SCOPE_REQUIRED, ORG_WIDE_TOKEN_REQUIRED, NOT_FOUND, …).

  • messagestring
  • statusinteger
  • successboolean
  • namestring
  • codestring

    FEATURE_NOT_ENABLED, AGENT_WRITES_PAUSED, …

  • featurestring
  • paused_atstring<date-time>

401

Missing, invalid or expired token.

403application/json

  • SCOPE_REQUIRED — the token lacks read:learning (reads) or write:learning (writes). Legacy tokens with no scopes cannot write.
  • ORG_WIDE_TOKEN_REQUIRED — the token is restricted to particular events: "The Learning workspace covers every event and learner in the organization, so this API key (restricted to particular events) cannot use it. Use a key without an event restriction."
  • FEATURE_NOT_ENABLED (feature: lessons_credits) — Learning is not on for the organization.
  • FORBIDDEN — the token's user is not an active member of the organization, or lacks the Lessons permission the operation needs.

Gateway errors carry error (a code) and message. Errors from Learning itself carry status, success: false, message, name, and sometimes code (and feature or paused_at).

  • errorstring | object

    The gateway's error code (SCOPE_REQUIRED, ORG_WIDE_TOKEN_REQUIRED, NOT_FOUND, …).

  • messagestring
  • statusinteger
  • successboolean
  • namestring
  • codestring

    FEATURE_NOT_ENABLED, AGENT_WRITES_PAUSED, …

  • featurestring
  • paused_atstring<date-time>

404application/json

orgId is not your organization (error: NOT_FOUND, message: Organization not found).

Gateway errors carry error (a code) and message. Errors from Learning itself carry status, success: false, message, name, and sometimes code (and feature or paused_at).

  • errorstring | object

    The gateway's error code (SCOPE_REQUIRED, ORG_WIDE_TOKEN_REQUIRED, NOT_FOUND, …).

  • messagestring
  • statusinteger
  • successboolean
  • namestring
  • codestring

    FEATURE_NOT_ENABLED, AGENT_WRITES_PAUSED, …

  • featurestring
  • paused_atstring<date-time>

429application/json

  • The token's request limit (100 requests per 15 minutes per bucket by default — see Rate Limiting). Wait Retry-After seconds.
  • QUOTA_EXCEEDED (writes) — the token's daily write quota (10,000 a day). Resets at midnight UTC.

Gateway errors carry error (a code) and message. Errors from Learning itself carry status, success: false, message, name, and sometimes code (and feature or paused_at).

  • errorstring | object

    The gateway's error code (SCOPE_REQUIRED, ORG_WIDE_TOKEN_REQUIRED, NOT_FOUND, …).

  • messagestring
  • statusinteger
  • successboolean
  • namestring
  • codestring

    FEATURE_NOT_ENABLED, AGENT_WRITES_PAUSED, …

  • featurestring
  • paused_atstring<date-time>
  • Retry-Afterintegerheader

    Seconds to wait before retrying.

Response examples

{
"success": true,
"payload": {
"within_days": 123,
"total": 123,
"people": [
{
"person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>",
"certification": "<string>",
"certification_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expires_at": "2026-01-15T09:30:00Z",
"days_left": 123,
"expired": true,
"next_lesson": {
"lesson_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content_id": "<string>",
"title": "<string>",
"kind": "course",
"minutes": 123,
"credit": [
{
"type_id": null,
"name": null,
"amount": null
}
],
"event": "<string>",
"session": "<string>",
"reason": "renewal",
"because": "<string>",
"rank": 123,
"earns_credit": true
}
}
],
"summary": "<string>"
}
}