LearnWorlds API

https://www.learnworlds.dev/docs/api/
Admin
LearnWorlds API is a comprehensive e-learning platform API that enables seamless integration with...
Tokens:57,261
Snippets:177
Trust Score:5.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### Subscription Trial Started Webhook

Source: https://www.learnworlds.dev/docs/api/branches/main/5cc9374300b99-webhooks

This webhook is triggered when a subscription trial is started. It sends a POST JSON request to a specified URL with details about the trial start event.

```APIDOC
## Subscription Trial Started Webhook

### Description
This webhook is triggered when a subscription trial is started. It sends a POST JSON request to a specified URL with details about the trial start event.

### Method
POST

### Endpoint
`/webhooks/subscription/trial_started` (Assumed, as no explicit endpoint is provided)

### Request Body
The request body is a JSON object containing details about the trial start event.

### Request Example
```json
{
  "version": 2,
  "school_id": "5f2ad376d0c4c5292d2ed292",
  "type": "subscriptionTrialStarted",
  "trigger": "subscription_trial_started",
  "data": {
    "date": 1638190255,
    "subscription": {
      "access": "public",
      "afterPurchase": {
        "settings": {
          "page": "1-click-sales",
          "url": null
        },
        "type": "afterlogin"
      },
      "created": 1636451207.689936,
      "description": null,
      "id": "test",
      "image": null,
      "interval": 2,
      "interval_type": "month",
      "modified": 1636451424.295151,
      "price": 100,
      "products": {
        "courses": [
          "course-2",
          "test-certificate-2",
          "test-certificate-6"
        ]
      },
      "stripePlanId": "test",
      "title": "test",
      "trial_period_days": 4
    },
    "user": {
      "created": 1635857322.970936,
      "email": "john@doe.com",
      "eu_customer": false,
      "fields": {
        "address": null,
        "behance": null,
        "bio": null,
        "birthday": null,
        "cf_afreetext": "test",
        "cf_checkme": true,
        "cf_datetest": null,
        "cf_herosradiobuttons": "superman",
        "cf_rgbcolors": "red",
        "company": null,
        "company_size": null,
        "country": null,
        "dribbble": null,
        "fb": null,
        "github": null,
        "graduation_year": null,
        "instagram": null,
        "linkedin": null,
        "location": null,
        "phone": null,
        "skype": null,
        "twitter": null,
        "university": null,
        "url": null
      },
      "id": "618133ab0d754108b05bad07",
      "is_admin": false,
      "is_affiliate": false,
      "is_instructor": false,
      "is_reporter": false,
      "role": {
        "level": "user",
        "name": "User"
      },
      "last_login": 1638190239.649997,
      "signup_approval_status": "passed",
      "referrer_id": null,
      "subscribed_for_marketing_emails": null,
      "tags": [],
      "username": "Learner Plus test",
      "first_name": "Learner",
      "last_name": "Plus test",
      "utms": {
        "fc_landing": "/",
        "lc_landing": "/"
      },
      "billing_info": {
        "bf_name" : "Sherlock Holmes",
        "bf_address" : "Baker Street 221B",
        "bf_city" : "London",
        "bf_postalcode" : "NW1",
        "bf_country" : "UK",
        "bf_taxid" : null
      },
      "nps_score": 9,
      "nps_comment": "Fantastic learning resources."
    }
  }
}
```
```

--------------------------------

### Subscription Trial Started

Source: https://www.learnworlds.dev/docs/api/5cc9374300b99-webhooks

Triggers a POST JSON request to a specified URL when a subscription trial is started. This event provides details about the trial, the subscription, and the user.

```APIDOC
## Subscription Trial Started

### Description
This webhook is triggered when a user starts a subscription trial. It sends a POST JSON request to a configured URL with details about the trial, the subscription plan, and the user.

### Method
POST

### Endpoint
`/webhooks` (Assumed, as the text specifies a POST request to a 'specified url')

### Request Body
- **version** (integer) - The version of the webhook payload.
- **school_id** (string) - The ID of the school.
- **type** (string) - The type of the event, e.g., "subscriptionTrialStarted".
- **trigger** (string) - The specific trigger for the event, e.g., "subscription_trial_started".
- **data** (object) - Contains detailed information about the event.
  - **date** (integer) - Timestamp of the event.
  - **subscription** (object) - Information about the subscription trial.
    - **access** (string) - Access level of the subscription.
    - **afterPurchase** (object) - Settings for after purchase actions.
      - **settings** (object) - Specific settings for after purchase.
        - **page** (string) - The page to redirect to.
        - **url** (string) - A custom URL for redirection.
      - **type** (string) - The type of after purchase action.
    - **created** (integer) - Timestamp of subscription creation.
    - **description** (string) - Description of the subscription.
    - **id** (string) - The subscription ID.
    - **image** (string) - URL of the subscription image.
    - **interval** (integer) - The subscription interval.
    - **interval_type** (string) - The type of interval (e.g., "month").
    - **modified** (integer) - Timestamp of the last modification.
    - **price** (integer) - The price of the subscription.
    - **products** (object) - List of products included in the subscription.
      - **courses** (array) - List of course IDs.
    - **stripePlanId** (string) - The Stripe Plan ID.
    - **title** (string) - The title of the subscription.
    - **trial_period_days** (integer) - The duration of the trial period in days.
  - **user** (object) - Information about the user who started the trial.
    - **created** (integer) - Timestamp of user creation.
    - **email** (string) - User's email address.
    - **eu_customer** (boolean) - Indicates if the user is an EU customer.
    - **fields** (object) - Custom fields associated with the user.
    - **id** (string) - The user ID.
    - **is_admin** (boolean) - Indicates if the user is an admin.
    - **is_affiliate** (boolean) - Indicates if the user is an affiliate.
    - **is_instructor** (boolean) - Indicates if the user is an instructor.
    - **is_reporter** (boolean) - Indicates if the user is a reporter.
    - **role** (object) - User's role information.
      - **level** (string) - The role level.
      - **name** (string) - The role name.
    - **last_login** (integer) - Timestamp of the last login.
    - **signup_approval_status** (string) - The status of signup approval.
    - **referrer_id** (string) - The ID of the referrer, if any.
    - **subscribed_for_marketing_emails** (boolean) - Indicates if subscribed to marketing emails.
    - **tags** (array) - List of tags associated with the user.
    - **username** (string) - The user's username.
    - **first_name** (string) - The user's first name.
    - **last_name** (string) - The user's last name.
    - **utms** (object) - UTM parameters associated with the user's signup.
    - **billing_info** (object) - User's billing information.
    - **nps_score** (integer) - NPS score provided by the user.
    - **nps_comment** (string) - NPS comment provided by the user.

### Request Example
```json
{
  "version": 2,
  "school_id": "5f2ad376d0c4c5292d2ed292",
  "type": "subscriptionTrialStarted",
  "trigger": "subscription_trial_started",
  "data": {
    "date": 1638190255,
    "subscription": {
      "access": "public",
      "afterPurchase": {
        "settings": {
          "page": "1-click-sales",
          "url": null
        },
        "type": "afterlogin"
      },
      "created": 1636451207.689936,
      "description": null,
      "id": "test",
      "image": null,
      "interval": 2,
      "interval_type": "month",
      "modified": 1636451424.295151,
      "price": 100,
      "products": {
        "courses": [
          "course-2",
          "test-certificate-2",
          "test-certificate-6"
        ]
      },
      "stripePlanId": "test",
      "title": "test",
      "trial_period_days": 4
    },
    "user": {
      "created": 1635857322.970936,
      "email": "john@doe.com",
      "eu_customer": false,
      "fields": {
        "address": null,
        "behance": null,
        "bio": null,
        "birthday": null,
        "cf_afreetext": "test",
        "cf_checkme": true,
        "cf_datetest": null,
        "cf_herosradiobuttons": "superman",
        "cf_rgbcolors": "red",
        "company": null,
        "company_size": null,
        "country": null,
        "dribbble": null,
        "fb": null,
        "github": null,
        "graduation_year": null,
        "instagram": null,
        "linkedin": null,
        "location": null,
        "phone": null,
        "skype": null,
        "twitter": null,
        "university": null,
        "url": null
      },
      "id": "618133ab0d754108b05bad07",
      "is_admin": false,
      "is_affiliate": false,
      "is_instructor": false,
      "is_reporter": false,
      "role": {
        "level": "user",
        "name": "User"
      },
      "last_login": 1638190239.649997,
      "signup_approval_status": "passed",
      "referrer_id": null,
      "subscribed_for_marketing_emails": null,
      "tags": [],
      "username": "Learner Plus test",
      "first_name": "Learner",
      "last_name": "Plus test",
      "utms": {
        "fc_landing": "/",
        "lc_landing": "/"
      },
      "billing_info": {
        "bf_name" : "Sherlock Holmes",
        "bf_address" : "Baker Street 221B",
        "bf_city" : "London",
        "bf_postalcode" : "NW1",
        "bf_country" : "UK",
        "bf_taxid" : null
      },
      "nps_score": 9,
      "nps_comment": "Fantastic learning resources."
    }
  }
}
```
```

--------------------------------

### Subscription Trial Started Webhook

Source: https://www.learnworlds.dev/docs/api/5cc9374300b99-webhooks

This webhook is triggered when a subscription trial begins. It sends a POST JSON request to a specified URL containing details about the trial start event and the associated subscription and user.

```json
{
  "version": 2,
  "school_id": "5f2ad376d0c4c5292d2ed292",
  "type": "subscriptionTrialStarted",
  "trigger": "subscription_trial_started",
  "data": {
    "date": 1638190255,
    "subscription": {
      "access": "public",
      "afterPurchase": {
        "settings": {
          "page": "1-click-sales",
          "url": null
        },
        "type": "afterlogin"
      },
      "created": 1636451207.689936,
      "description": null,
      "id": "test",
      "image": null,
      "interval": 2,
      "interval_type": "month",
      "modified": 1636451424.295151,
      "price": 100,
      "products": {
        "courses": [
          "course-2",
          "test-certificate-2",
          "test-certificate-6"
        ]
      },
      "stripePlanId": "test",
      "title": "test",
      "trial_period_days": 4
    },
    "user": {
      "created": 1635857322.970936,
      "email": "john@doe.com",
      "eu_customer": false,
      "fields": {
        "address": null,
        "behance": null,
        "bio": null,
        "birthday": null,
        "cf_afreetext": "test",
        "cf_checkme": true,
        "cf_datetest": null,
        "cf_herosradiobuttons": "superman",
        "cf_rgbcolors": "red",
        "company": null,
        "company_size": null,
        "country": null,
        "dribbble": null,
        "fb": null,
        "github": null,
        "graduation_year": null,
        "instagram": null,
        "linkedin": null,
        "location": null,
        "phone": null,
        "skype": null,
        "twitter": null,
        "university": null,
        "url": null
      },
      "id": "618133ab0d754108b05bad07",
      "is_admin": false,
      "is_affiliate": false,
      "is_instructor": false,
      "is_reporter": false,
      "role": {
        "level": "user",
        "name": "User"
      },
      "last_login": 1638190239.649997,
      "signup_approval_status": "passed",
      "referrer_id": null,
      "subscribed_for_marketing_emails": null,
      "tags": [],
      "username": "Learner Plus test",
      "first_name": "Learner",
      "last_name": "Plus test",
      "utms": {
        "fc_landing": "/",
        "lc_landing": "/"
      },
      "billing_info": {
        "bf_name" : "Sherlock Holmes",
        "bf_address" : "Baker Street 221B",
        "bf_city" : "London",
        "bf_postalcode" : "NW1",
        "bf_country" : "UK",
        "bf_taxid" : null
      },
      "nps_score": 9,
      "nps_comment": "Fantastic learning resources."
    }
  }
}
```

--------------------------------

### Example API Access Token Response

Source: https://www.learnworlds.dev/docs/api/branches/main/b6b6c2d4906e9-authentication

This is the expected JSON structure when successfully obtaining an access token. It includes the token, type, and expiration period.

```json
{
  "tokenData": {
    "access_token": "tZGB6EHKfzMs9ecUFhPxDtXflQPKqHACIvcrd4Wx",
    "token_type": "Bearer",
    "expires_in": 8000
  },
  "errors": [],
  "success": true
}
```

--------------------------------

### Product Bought Webhook Request Example

Source: https://www.learnworlds.dev/docs/api/5cc9374300b99-webhooks

This JSON payload is sent to your specified URL when a product is purchased. It contains details about the transaction, the product, and the user.

```json
{
  "version": 2,
  "type": "productBought",
  "trigger": "new_purchase",
  "school_id": "60004a6de11ac0798538ccc2",
  "data": {
    "ip_address": null,
    "payment": {
      "affiliate": null,
      "coupon": null,
      "created": 1637235626.53355,
      "discount": 0,
      "gateway": null,
      "id": "61963baafbbd1d36c777b493",
      "instructors": [],
      "instructors_total_percentage": null,
      "invoice": null,
      "billing_info": {
        "bf_name" : "Sherlock Holmes",
        "bf_address" : "Baker Street 221B",
        "bf_city" : "London",
        "bf_postalcode" : "NW1",
        "bf_country" : "UK",
        "bf_taxid" : null
      },
      "paid_at": 1637235626.56606,
      "payment_plan_current_payment": null,
      "payment_plan_total_payments": null,
      "period": null,
      "price": 100,
      "product": {
        "description": null,
        "discount_price": 0,
        "final_price": 100,
        "id": "webex",
        "image": null,
        "name": "Webex",
        "original_price": 100,
        "trial_days": 0,
        "type": "course"
      },
      "refund_at": null,
      "tax_amount": 0,
      "tax_percentage": 0,
      "transaction_id": "Added by admin",
      "type": "one-off",
      "user_id": "618e6db9cfb2226fe229d927"
    },
    "user": {
      "created": 1636724153.189269,
      "email": "john@doe.com",
      "eu_customer": false,
      "fields": {
        "address": null,
        "behance": null,
        "bio": "my story",
        "birthday": null,
        "company": null,
        "company_size": null,
        "country": null,
        "dribbble": null,
        "fb": null,
        "github": null,
        "graduation_year": "2000",
        "instagram": null,
        "linkedin": null,
        "location": "Athens",
        "phone": null,
        "skype": null,
        "twitter": "htttps://www.twitter.com",
        "university": null,
        "url": "https://test.com"
      },
      "id": "618e6db9cfb2226fe229d927",
      "is_admin": false,
      "is_affiliate": true,
      "is_instructor": false,
      "is_reporter": false,
      "role": {
        "level": "user",
        "name": "User"
      },
      "last_login": 1637222305.3564,
      "signup_approval_status": "passed",
      "referrer_id": null,
      "subscribed_for_marketing_emails": null,
      "tags": [
        "testgeo",
        "test2geo"
      ],
      "username": "johndoe",
      "first_name": "",
      "last_name": "johndoe",
      "utms": {
        "fc_campaign": "WOW campaign",
        "fc_content": null,
        "fc_country": null,
        "fc_landing": "/",
        "fc_medium": "FB",
        "fc_referrer": null,
        "fc_source": "Facebook",
        "fc_term": null,
        "lc_campaign": null,
        "lc_content": null,
        "lc_country": null,
        "lc_landing": "/",
        "lc_medium": null,
        "lc_referrer": null,
        "lc_source": null,
        "lc_term": null
      },
      "billing_info": {
        "bf_name" : "Sherlock Holmes",
        "bf_address" : "Baker Street 221B",
        "bf_city" : "London",
        "bf_postalcode" : "NW1",
        "bf_country" : "UK",
        "bf_taxid" : null
      },
      "nps_score": 9,
      "nps_comment": "Fantastic learning resources."
    }
  }
}
```

--------------------------------

### Webhook Signature Header Example

Source: https://www.learnworlds.dev/docs/api/5cc9374300b99-webhooks

This header is included with each incoming webhook from LearnWorlds. It is used to verify the authenticity of the payload.

```text
Learnworlds-Webhook-Signature: v1=e8fad5b079d0977f61bc2d21fc5f461719e6478df7de56
```

--------------------------------

### GET /event-logs

Source: https://www.learnworlds.dev/docs/api/branches/main/17ce94ba40ba9-api

Retrieves event logs, with options to filter by manual enrollment or all enrollment events. Both return justification and is_manual fields.

```APIDOC
## GET /event-logs

### Description
Retrieves event logs. The `manual_enrollment` field returns only manual enrollment events, while the new `enrollment` field returns all enrollment events.

### Method
GET

### Endpoint
/event-logs

### Parameters
#### Query Parameters
- **manual_enrollment** (boolean) - Optional - Returns manual enrollment events only.
- **enrollment** (boolean) - Optional - Returns all enrollment events.

### Response
#### Success Response (200)
- **justification** (string) - Description of the event.
- **is_manual** (boolean) - Indicates if the event was manually triggered.

#### Response Example
{
  "example": "{\"justification\": \"User enrolled manually\", \"is_manual\": true}"
}
```

--------------------------------

### SSO with User Access Token Response

Source: https://www.learnworlds.dev/docs/api/branches/main/58052c1c3066e-single-sign-on

This is an example of a successful response when using the SSO with User Access Token endpoint. It confirms success and provides a redirect URL.

```json
{
  "success": true,
  "url": "https://your-domain.com/login?code=secret-code-here"
}
```

--------------------------------

### Payment Created Webhook Event Example

Source: https://www.learnworlds.dev/docs/api/5cc9374300b99-webhooks

This JSON object represents the payload received when a payment is created. It includes details about the payment, the product purchased, and the user making the purchase.

```json
{
  "version": 2,
  "type": "paymentCreated",
  "trigger": "new_purchase",
  "school_id": "60004a6de11ac0798538ccc2",
  "data": {
    "payment": {
      "affiliate": null,
      "coupon": null,
      "created": 1637235626.53355,
      "discount": 0,
      "gateway": null,
      "id": "61963baafbbd1d36c777b493",
      "instructors": [],
      "instructors_total_percentage": null,
      "invoice": null,
      "billing_info": {
        "bf_name" : "Sherlock Holmes",
        "bf_address" : "Baker Street 221B",
        "bf_city" : "London",
        "bf_postalcode" : "NW1",
        "bf_country" : "UK",
        "bf_taxid" : null
      },
      "paid_at": 1637235626.56606,
      "payment_plan_current_payment": null,
      "payment_plan_total_payments": null,
      "period": null,
      "price": 100,
      "product": {
        "description": null,
        "discount_price": 0,
        "final_price": 100,
        "id": "webex",
        "image": null,
        "name": "Webex",
        "original_price": 100,
        "trial_days": 0,
        "type": "course"
      },
      "refund_at": null,
      "tax_amount": 0,
      "tax_percentage": 0,
      "transaction_id": "Added by admin",
      "type": "one-off",
      "user_id": "618e6db9cfb2226fe229d927"
    },
    "user": {
      "created": 1636724153.189269,
      "email": "john@doe.com",
      "eu_customer": false,
      "fields": {
        "address": null,
        "behance": null,
        "bio": "my story",
        "birthday": null,
        "company": null,
        "company_size": null,
        "country": null,
        "dribbble": null,
        "fb": null,
        "github": null,
        "graduation_year": "2000",
        "instagram": null,
        "linkedin": null,
        "location": "Athens",
        "phone": null,
        "skype": null,
        "twitter": "htttps://www.twitter.com",
        "university": null,
        "url": "https://test.com"
      },
      "id": "618e6db9cfb2226fe229d927",
      "is_admin": false,
      "is_affiliate": true,
      "is_instructor": false,
      "is_reporter": false,
      "role": {
        "level": "user",
        "name": "User"
      },
      "last_login": 1637222305.3564,
      "signup_approval_status": "passed",
      "referrer_id": null,
      "subscribed_for_marketing_emails": null,
      "tags": [
        "testgeo",
        "test2geo"
      ],
      "username": "johndoe",
      "first_name": "",
      "last_name": "johndoe",
      "utms": {
        "fc_campaign": "WOW campaign",
        "fc_content": null,
        "fc_country": null,
        "fc_landing": "/",
        "fc_medium": "FB",
        "fc_referrer": null,
        "fc_source": "Facebook",
        "fc_term": null,
        "lc_campaign": null,
        "lc_content": null,
        "lc_country": null,
        "lc_landing": "/",
        "lc_medium": null,
        "lc_referrer": null,
        "lc_source": null,
        "lc_term": null
      },
      "billing_info": {
        "bf_name" : "Sherlock Holmes",
        "bf_address" : "Baker Street 221B",
        "bf_city" : "London",
        "bf_postalcode" : "NW1",
        "bf_country" : "UK",
        "bf_taxid" : null
      },
      "nps_score": 9,
      "nps_comment": "Fantastic learning resources."
    }
  }
}
```

--------------------------------

### SSO Login with Email or User ID

Source: https://www.learnworlds.dev/docs/api/58052c1c3066e-single-sign-on

Use this endpoint to log in users automatically by providing their email or LearnWorlds user ID. It handles both new user creation and existing user login. For existing users, `username` and `avatar` can be updated, but `custom_fields` and `tags` are only applied during new user creation.

```bash
curl --location 'https://{SCHOOLHOMEPAGE}/admin/api/sso' \
--header 'Lw-Client: your_client_id' \
--header 'Authorization: Bearer application_access_token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'data={
  "email":"user@example.com",
  "username":"Jane Doe",
  "first_name":"Jane",
  "last_name":"Doe",
  "custom_fields":{
    "cf_country":"Greece",
    "cf_privacy":"true",
    "cf_subscriptionplan":"premium"
  },
  "tags":["super-user","sso"],
  "redirectUrl":"https://your-app.example.com/after-login"
}'
```

--------------------------------

### Free Section Previewed Webhook

Source: https://www.learnworlds.dev/docs/api/5cc9374300b99-webhooks

This webhook triggers a POST JSON request to a specified URL when a user previews a free section of a course. It includes details about the course and the user.

```APIDOC
## POST /webhooks

### Description
Triggers a POST JSON request to the specified url when a free section is previewed. This webhook provides information about the course and the user who previewed the section.

### Method
POST

### Endpoint
/webhooks

### Request Body
- **version** (integer) - Required - The version of the webhook payload.
- **type** (string) - Required - The type of the webhook event, 'previewedFree' in this case.
- **trigger** (string) - Required - The specific trigger event, 'free_section_previewed'.
- **school_id** (string) - Required - The ID of the school.
- **data** (object) - Required - Contains details about the course and the user.
  - **course** (object) - Required - Information about the course.
    - **access** (string) - Required - Course access type.
    - **afterPurchase** (object) - Optional - Settings related to after purchase.
    - **author** (string) - Optional - The author of the course.
    - **categories** (array) - Optional - List of course categories.
    - **courseImage** (string) - Optional - URL of the course image.
    - **created** (number) - Required - Timestamp of course creation.
    - **description** (string) - Required - Description of the course.
    - **discount_price** (number) - Required - The discounted price of the course.
    - **dripFeed** (string) - Required - Drip feed setting.
    - **expires** (any) - Optional - Expiration setting.
    - **expiresType** (string) - Required - Type of expiration.
    - **final_price** (number) - Required - The final price of the course.
    - **id** (string) - Required - The unique identifier for the course.
    - **label** (string) - Optional - Label for the course.
    - **modified** (number) - Required - Timestamp of last modification.
    - **original_price** (number) - Required - The original price of the course.
    - **title** (string) - Required - The title of the course.
    - **identifiers** (object) - Required - Store identifiers for the course.
      - **google_store_id** (string) - Required - Google Play Store ID.
      - **apple_store_id** (string) - Required - Apple App Store ID.
  - **user** (object) - Required - Information about the user.
    - **created** (number) - Required - Timestamp of user creation.
    - **email** (string) - Required - User's email address.
    - **eu_customer** (boolean) - Optional - Indicates if the user is an EU customer.
    - **fields** (object) - Optional - Custom user fields.
    - **id** (string) - Required - The unique identifier for the user.
    - **is_admin** (boolean) - Required - Indicates if the user is an admin.
    - **is_affiliate** (boolean) - Required - Indicates if the user is an affiliate.
    - **is_instructor** (boolean) - Required - Indicates if the user is an instructor.
    - **is_reporter** (boolean) - Required - Indicates if the user is a reporter.
    - **role** (object) - Required - User's role information.
      - **level** (string) - Required - The role level.
      - **name** (string) - Required - The role name.
    - **last_login** (number) - Required - Timestamp of last login.
    - **signup_approval_status** (string) - Required - Status of signup approval.
    - **referrer_id** (string) - Optional - ID of the referrer.
    - **subscribed_for_marketing_emails** (boolean) - Optional - Subscription status for marketing emails.
    - **tags** (array) - Optional - List of user tags.
    - **username** (string) - Required - User's username.
    - **first_name** (string) - Required - User's first name.
    - **last_name** (string) - Required - User's last name.
    - **utms** (object) - Optional - UTM parameters associated with the user.
    - **billing_info** (object) - Optional - User's billing information.
    - **nps_score** (integer) - Optional - NPS score provided by the user.
    - **nps_comment** (string) - Optional - NPS comment provided by the user.

### Request Example
```json
{
  "version": 2,
  "type": "previewedFree",
  "trigger": "free_section_previewed",
  "school_id": "60004a6de11ac0798538ccc2",
  "data": {
    "course": {
      "access": "paid",
      "afterPurchase": {
        "settings": {
          "page": null,
          "url": null
        },
        "type": "course"
      },
      "author": null,
      "categories": [
        "learning how to sleep",
        "sleep now",
        "sleeping like a pro"
      ],
      "courseImage": null,
      "created": 1510243831.36581,
      "description": "this is the description",
      "discount_price": 3,
      "dripFeed": "date",
      "expires": null,
      "expiresType": "weeks",
      "final_price": 3,
      "id": "10-secrets-of-sleep-walking",
      "label": null,
      "modified": 1637228295.279494,
      "original_price": 300,
      "title": "10 secrets of sleep walking",
      "identifiers": {
        "google_store_id": "10_secrets_of_sleep_walking",
        "apple_store_id": "10_secrets_of_sleep_walking"
      }
    },
    "user": {
      "created": 1636706835.084109,
      "email": "john@doe.com",
      "eu_customer": null,
      "fields": {
        "address": null,
        "behance": null,
        "bio": "my story",
        "birthday": null,
        "cf_checkboxtest": null,
        "cf_drop": null,
        "cf_mycustom": null,
        "cf_test": "123",
        "company": null,
        "company_size": null,
        "country": null,
        "dribbble": null,
        "fb": "htttps://www.fb.com",
        "github": null,
        "graduation_year": "2000",
        "instagram": null,
        "linkedin": null,
        "location": "Panormo",
        "phone": null,
        "skype": null,
        "twitter": "htttps://www.twitter.com",
        "university": null,
        "url": "https://test.com"
      },
      "id": "618e2a13b1085d69803d4804",
      "is_admin": false,
      "is_affiliate": true,
      "is_instructor": false,
      "is_reporter": false,
      "role": {
        "level": "user",
        "name": "User"
      },
      "last_login": 1637228524.950613,
      "signup_approval_status": "passed",
      "referrer_id": null,
      "subscribed_for_marketing_emails": null,
      "tags": [
        "testgeo",
        "test2geo"
      ],
      "username": "johndoe",
      "first_name": "",
      "last_name": "johndoe",
      "utms": {
        "fc_landing": "/",
        "lc_landing": "/"
      },
      "billing_info": {
        "bf_name" : "Sherlock Holmes",
        "bf_address" : "Baker Street 221B",
        "bf_city" : "London",
        "bf_postalcode" : "NW1",
        "bf_country" : "UK",
        "bf_taxid" : null
      },
      "nps_score": 9,
      "nps_comment": "Fantastic learning resources."
    }
  }
}
```

### Response
(No specific response details were provided in the source text.)
```

--------------------------------

### Status Codes and Errors

Source: https://www.learnworlds.dev/docs/api/branches/main/17ce94ba40ba9-api

This section details the HTTP status codes used by the API and provides examples of common error responses.

```APIDOC
## Status Codes and Errors

 __
This API uses HTTP status codes to communicate with the API consumer.
  * `200 OK` - Response to a successful GET, PUT.
  * `201 Created` - Response to a POST that the resource is succesfully created.
  * `204 No Content` - Response to a successful request that won't be returning a body (like a DELETE request).
  * `400 Bad Request` - Bad request
  * `401 Unauthorized` - When no or invalid authentication details are provided.
  * `403 Forbidden` - When authentication succeeded but authenticated user doesn't have access to the resource.
  * `404 Not Found` - When a non-existent resource is requested.
  * `422 Validation error` - You should check your input again.
  * `429 Too many requests` - The consumer has sent too many requests in a given amount of time (“rate limiting”).
  * `500 Server error` - A general server error.

### 
Examples
 __
#### Bad Request
```

{
  "errors": [
    {
      "code": "400",
      "context": "access_denied",
      "message": "The resource owner or authorization server denied the request."
    }
  ],
  "success": false
}
__

```

#### Too many Requests
```

{
  "error": "Too many requests"
}
__

```

#### Unauthorized
```

{
  "errors": [
    {
      "code": "401",
      "context": null,
      "message": "Invalid object ID"
    }
  ],
  "success": false
}
__

```

#### Resource not found
```

{
  "error": "Sorry the resource your trying to access does not exist."
}
__

```

#### Validation Error
```

{
  "error": "You need to provide a valid product_type query parameters value: 'course', 'bundle', 'subscription'"
}
__

```

#### Generic Error
```

{
  "error": "Server Error" 
}
__

```

* * *
```

--------------------------------

### Generate Access Token using Resource Owner Credentials Grant

Source: https://www.learnworlds.dev/docs/api/branches/main/b6b6c2d4906e9-authentication

Use this cURL command to request an access token by providing user credentials and client details. Replace `{SCHOOLHOMEPAGE}`, `your_client_id`, and `your_client_secret` with your specific values. The `email` and `password` fields should contain the user's login credentials.

```bash
curl "https://{SCHOOLHOMEPAGE}/admin/api/oauth2/access_token" \
  -H "Lw-Client: your_client_id" \
  -d data='{
     "client_id":"your_client_id",
     "client_secret":"your_client_secret",
     "grant_type":"password",
     "email":"info@learnworlds.com",
     "password":"learnworlds"
    }'
```

--------------------------------

### Error Response for Invalid or Expired Token

Source: https://www.learnworlds.dev/docs/api/branches/main/b6b6c2d4906e9-authentication

This is an example of an error response when an access token is bad or expired. The response indicates that the request was denied.

```json
{
  "errors": [
    {
      "code": 400,
      "context": "access_denied",
      "message": "The resource owner or authorization server denied the request."
    }
  ],
  "success": false
}
```

--------------------------------

### SSO with User Access Token Request

Source: https://www.learnworlds.dev/docs/api/branches/main/58052c1c3066e-single-sign-on

Use this cURL command to log in a user to your LearnWorlds school using their existing user access token. The user will be redirected to the specified URL after successful login.

```bash
curl -X POST https://{SCHOOLHOMEPAGE}/admin/api/user/sso \
-H "Lw-Client: your_client_id" \
-H "Authorization: Bearer users_access_token" \
-d data='{
   "redirectUrl":"https://learnworlds.com"
  }'
```

--------------------------------

### GET /payments

Source: https://www.learnworlds.dev/docs/api/branches/main/17ce94ba40ba9-api

Retrieves a list of payments. Enhanced with new fields for external invoice and currency code, and updated instructor and discount fields.

```APIDOC
## GET /payments

### Description
Retrieves a list of payments. This endpoint has been enhanced with new fields `external_invoice` and `currency_code`. The `instructors` array now includes `username`, and the `discount` field returns an object with `amount` and `currency`.

### Method
GET

### Endpoint
/payments

### Response
#### Success Response (200)
- **external_invoice** (string) - Information about the external invoice.
- **currency_code** (string) - The currency code for the payment.
- **instructors** (array) - An array of instructor objects, each including `username`.
- **discount** (object) - An object containing discount details:
  - **amount** (float) - The discount amount.
  - **currency** (string) - The currency of the discount.

#### Response Example
{
  "example": "{\"external_invoice\": \"INV-12345\", \"currency_code\": \"USD\", \"instructors\": [{\"username\": \"john_doe\"}], \"discount\": {\"amount\": 10.0, \"currency\": \"USD\"}}"
}
```

--------------------------------

### SSO with Email or User ID

Source: https://www.learnworlds.dev/docs/api/58052c1c3066e-single-sign-on

Use this endpoint when you have either a user's email or LearnWorlds user ID and want to log them in automatically. If the user does not exist, LearnWorlds creates a new user and logs them in. If the user already exists, LearnWorlds logs them in. For existing users, this flow can update `username` and `avatar` if provided.

```APIDOC
## POST /admin/api/sso

### Description
Initiates a Single Sign-On flow using a user's email or LearnWorlds User ID. This endpoint can create a new user if one doesn't exist or log in an existing user. It supports updating username and avatar for existing users.

### Method
POST

### Endpoint
`https://{SCHOOLHOMEPAGE}/admin/api/sso`

### Parameters
#### Request Body
- **email** (string) - Required. User email. Required when `user_id` is not provided.
- **user_id** (string) - Optional. LearnWorlds user ID. Can be used instead of `email`.
- **username** (string) - Required for new user creation in setups where username is required. User display name.
- **first_name** (string) - Optional. First name for user creation.
- **last_name** (string) - Optional. Last name for user creation.
- **avatar** (string) - Optional. URL to the user's avatar image.
- **custom_fields** (object) - Optional. Object of user custom fields (key-value pairs). Applied on user creation. Not used to update existing users in this flow.
- **tags** (array) - Optional. Array of tag values. Applied on user creation. Not used to update existing users in this flow.
- **redirectUrl** (string) - Optional. Full URL where the user will be redirected after login.
- **token** (string) - Optional. If present, returns token data instead of a redirect URL.

### Request Example
```json
{
  "email": "user@example.com",
  "username": "Jane Doe",
  "first_name": "Jane",
  "last_name": "Doe",
  "custom_fields": {
    "cf_country": "Greece",
    "cf_privacy": "true",
    "cf_subscriptionplan": "premium"
  },
  "tags": ["super-user", "sso"],
  "redirectUrl": "https://your-app.example.com/after-login"
}
```

### Response
#### Success Response (200)
- **user_id** (string) - The ID of the newly created or existing user.
- **url** (string) - The login URL for the user.
- **errors** (array) - A list of errors encountered during the process.
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "user_id": "newly-created-or-existing-user-id",
  "url": "https://{SCHOOLHOMEPAGE}/login?code=secret-code-here",
  "errors": [],
  "success": true
}
```
```

--------------------------------

### GET /payment/{id}

Source: https://www.learnworlds.dev/docs/api/branches/main/17ce94ba40ba9-api

Retrieves details for a specific payment. Enhanced with new fields for external invoice and currency code, and updated instructor and discount fields.

```APIDOC
## GET /payment/{id}

### Description
Retrieves details for a specific payment. This endpoint has been enhanced with new fields `external_invoice` and `currency_code`. The `instructors` array now includes `username`, and the `discount` field returns an object with `amount` and `currency`.

### Method
GET

### Endpoint
/payment/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the payment.

### Response
#### Success Response (200)
- **external_invoice** (string) - Information about the external invoice.
- **currency_code** (string) - The currency code for the payment.
- **instructors** (array) - An array of instructor objects, each including `username`.
- **discount** (object) - An object containing discount details:
  - **amount** (float) - The discount amount.
  - **currency** (string) - The currency of the discount.

#### Response Example
{
  "example": "{\"external_invoice\": \"INV-12345\", \"currency_code\": \"USD\", \"instructors\": [{\"username\": \"john_doe\"}], \"discount\": {\"amount\": 10.0, \"currency\": \"USD\"}}"
}
```
Tokens:
Raw