Skip to main content
GET
/
analytics
/
lms
/
enrollments
Certification enrolments (paginated)
curl --request GET \
  --url https://api.journeybee.io/v1/analytics/lms/enrollments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "uuid": "<string>",
      "user_uuid": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "profile_image_uuid": "<string>",
      "partner_uuid": "<string>",
      "partner_company_name": "<string>",
      "certification_uuid": "<string>",
      "certification_name": "<string>",
      "progress_percentage": 123,
      "assessment_best_score": 123,
      "assessment_passed": true,
      "enrolled_at": "<string>",
      "started_at": "<string>",
      "completed_at": "<string>"
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 123
  }
}

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Query Parameters

period
enum<string>

Reporting period (resolved to a date range server-side). Defaults to current_year. Ignored when start_date + end_date are both supplied.

Available options:
current_year,
last_year,
current_quarter,
last_quarter,
current_month,
last_month,
last_30_days,
last_90_days,
last_6_months,
last_12_months
start_date
string

ISO date for a custom range start (use with end_date).

end_date
string

ISO date for a custom range end (use with start_date).

partner_type
enum<string>

Limit to one partner type; omit to include all partners.

Available options:
referral,
reseller,
distributor
lead_direction
enum<string>

For referral partners, which lead direction to count.

Available options:
received,
sent,
all
partner_uuids

Restrict to these partnerships (uuids). Pass a single uuid for one partner's scorecard.

category_uuids

Restrict to partners in these categories (uuids).

tier_uuids

Restrict to partners in these tiers (uuids).

stage_uuids

Restrict to partners in these partnership stages (uuids).

limit
integer

Max rows for list/leaderboard endpoints (default per endpoint).

Required range: 1 <= x <= 100
status
enum<string>
required

Which enrolments to list: in_progress, completed, or failed.

Available options:
in_progress,
completed,
failed
page
integer
Required range: 1 <= x <= 9007199254740991
per_page
integer
Required range: 1 <= x <= 100

Response

200 - application/json

Default Response

data
object[]
required
pagination
object
required