> ## Documentation Index > Fetch the complete documentation index at: https://help.kajabi.com/llms.txt > Use this file to discover all available pages before exploring further. # Course details > Details of a course that can be offered to a contact or purchased ## Course Attributes * `created_at` (string) - The date and time the course was created * `title` (string) - The title of the course * `description` (string) - The description of the course * `thumbnail_url` (string) - The URL of the course thumbnail ## Including Relationships Use the `include` query parameter to load related resources: ### Include modules, lessons and related media, and offers * `GET /v1/courses/123?include=modules,lessons,lessons.media,offers` Response will include the requested related resources (Note: The responses listed within the "included" array will also include the relationships for each resource) ```json { "data": { "id": "123", "type": "courses", "attributes": { "created_at": "2024-08-06T05:30:38.669Z", "title": "Advanced Marketing", "description": "Master level marketing course", "thumbnail_url": "https://example.com/thumbnail.jpg" }, "relationships": { "modules": { "data": [{ "id": "456", "type": "modules" }] }, "lessons": { "data": [{ "id": "789", "type": "lessons" }] }, "offers": { "data": [{ "id": "101", "type": "offers" }] } }, "included": [{ "id": "456", "type": "modules", "attributes": { "title": "Marketing Fundamentals", "description": "Introduction to marketing concepts", "position": 1, "poster_image_url": "https://example.com/poster.jpg", "publishing_option": "published" } }, { "id": "789", "type": "lessons", "attributes": { "title": "Marketing Basics", "position": 1, "status": "published", "publishing_option": "published" } }, { "id": "202", "type": "media", "attributes": { "duration_in_minutes": 1, } }, { "id": "101", "type": "offers", "attributes": { "price": 100.0, "currency": "USD", "status": "active" } }] } } ``` ## Module attributes Modules are part of Kajabi's course structure: courses contain modules and modules contain lessons * `title` (string) - A required field that represents the name or heading of the module. This is used to: * Identify and display the module in the course outline * Organize related lessons/content * Provide navigation structure in the course * The title must be unique within a course. * `description` (string) - An optional text field that provides additional information about the module's content. This can be used to: * Give students an overview of what they'll learn * Explain the module's objectives * Provide context for the contained lessons * Help students understand the module's purpose in the course structure * `position` (integer) - A numeric field that determines the order of modules within a course. This: * Used for sorting * Allows modules to be reordered * Maintains the course's logical progression * Is used for navigation between modules * Starts at position 1 for the first module * `poster_image_url` (string) - A URL to an image that represents the module visually. This: * Can be uploaded through the Kajabi admin interface * Is used as a thumbnail/preview image * Helps with visual organization of the course * `publishing_option` (string) - Controls the visibility and availability of the module. Options include: * `published` - Module is visible and available to students * `draft` - Module is hidden and not yet available * Can be used with drip settings for timed release * Affects the visibility of contained lessons * Syncs with the course's overall publishing status ## Lesson attributes Lessons can include various types of content: text content (body), videos, audio, quizzes, assessments, and downloads. * `title` (string) - A required field that represents the name or heading of the lesson. This: * Must be present * Has a maximum length of 200 characters * Is used for display and navigation * Can be searched (using pg_search) * Is used in course outlines and navigation * `position` (integer) - A numeric field that determines the order of lessons within a module (category). This: * Usedfor sorting (ranks :sort, column: :position) * Is scoped within each module * Allows lessons to be reordered * Maintains the logical flow of content * Is used for navigation between lessons * `status` (string) - An field that tracks the lesson's processing state: * `ready` - Default state, lesson is ready for use * `duplicating` - Lesson is being copied * `failed` - An error occurred during processing * This is particularly relevant for lessons with media content or during duplication. * `publishing_option` (string) - Controls the visibility and availability of the lesson. Options include: * `draft` - Lesson is hidden and not yet available to students * `published` - Lesson is visible and available (sets publish_at to current time) * `drip` - Lesson becomes available after a specified number of days * `locked` - Lesson is locked until certain conditions are met (e.g., completing previous lessons) ## Media attributes * `duration_in_minutes` (float) - The length of a media file (typically video or audio) in minutes. ## Sparse Fields Use the `fields` parameter to request only specific attributes: ### Only return title and thumbnail_url attributes * `GET /v1/courses/123?fields[courses]=title,thumbnail_url` Response will only include requested fields ```json { "data": { "id": "123", "type": "courses", "attributes": { "title": "Marketing Fundamentals", "thumbnail_url": "https://example.com/thumbnail.jpg" } } } ``` ## Using Multiple Parameters Together You can combine sparse fields and include in a single request: ### Get course details with modules and lessons, showing only specific fields * `GET /v1/courses/123?include=modules,lessons,lessons.media&fields[courses]=title,thumbnail_url&fields[modules]=title&fields[lessons]=title&fields[media]=duration_in_minutes` Response will include related resources with requested fields ```json { "data": { "id": "123", "type": "courses", "attributes": { "title": "Marketing Fundamentals", "thumbnail_url": "https://example.com/thumbnail.jpg" }, "relationships": {} }, "included": [{ "id": "456", "type": "modules", "attributes": { "title": "Marketing Basics" } }, { "id": "789", "type": "lessons", "attributes": { "title": "Marketing Strategies" } }, { "id": "101", "type": "media", "attributes": { "duration_in_minutes": 30 } }] } ``` ## OpenAPI ````yaml /openapi.yaml get /v1/courses/{id} openapi: 3.1.1 info: title: Kajabi API V1 version: 1.0.1 description: > ## Public API * Server URL `https://api.kajabi.com` * Endpoint paths are prefixed with `/v1` * Version endpoint `GET https://api.kajabi.com/v1/version` * See the [Developers Site](https://developers.kajabi.com) for documentation and examples. * Try the demo [Postman collection](https://www.postman.com/kajabi-apis/beta-public-api-demo/collection/fg4iyaz/kajabi-public-api-v1) ## API Keys * Your API `client_id` and `client_secret` are available on the [User API Keys](https://app.kajabi.com/admin/settings/security) section of the Kajabi Admin Portal. * Custom API Keys can be created with specific permissions. * Click the "Create User API Key" button, enter a name (e.g. "My project"), select the user and permissions, and click "Create". * For security purposes, you may "Delete" or "Rotate" the api credentials at any time; which will invalidate any access tokens granted with the credentials. ## Video Walkthroughs * [Capabilities](https://drive.google.com/file/d/1Puc9B2sSdA-RQb7YMxmUXg4FVoEXytoc/view?usp=sharing) * [Getting Started](https://drive.google.com/file/d/1hbGRShkxven_QMWvgYrerHKURbcZrnvJ/view?usp=sharing) * [Error Examples](https://drive.google.com/file/d/1i0wQK71I1jpaZVsxYwsn62gVj40S_E7Y/view?usp=sharing) * [External Contact Form](https://drive.google.com/file/d/1HqpULXvan5TOK3LvM7nILCuCkCaX0kFT/view?usp=sharing) contact: email: support@kajabi.com name: Support url: >- https://help.kajabi.com/hc/en-us/articles/4404549690523-How-to-Get-Help-From-Kajabi-Live-Agents license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://api.kajabi.com description: Production security: [] paths: /v1/courses/{id}: get: tags: - Courses summary: Course details description: > Details of a course that can be offered to a contact or purchased ## Course Attributes * `created_at` (string) - The date and time the course was created * `title` (string) - The title of the course * `description` (string) - The description of the course * `thumbnail_url` (string) - The URL of the course thumbnail ## Including Relationships Use the `include` query parameter to load related resources: ### Include modules, lessons and related media, and offers * `GET /v1/courses/123?include=modules,lessons,lessons.media,offers` Response will include the requested related resources (Note: The responses listed within the "included" array will also include the relationships for each resource) ```json { "data": { "id": "123", "type": "courses", "attributes": { "created_at": "2024-08-06T05:30:38.669Z", "title": "Advanced Marketing", "description": "Master level marketing course", "thumbnail_url": "https://example.com/thumbnail.jpg" }, "relationships": { "modules": { "data": [{ "id": "456", "type": "modules" }] }, "lessons": { "data": [{ "id": "789", "type": "lessons" }] }, "offers": { "data": [{ "id": "101", "type": "offers" }] } }, "included": [{ "id": "456", "type": "modules", "attributes": { "title": "Marketing Fundamentals", "description": "Introduction to marketing concepts", "position": 1, "poster_image_url": "https://example.com/poster.jpg", "publishing_option": "published" } }, { "id": "789", "type": "lessons", "attributes": { "title": "Marketing Basics", "position": 1, "status": "published", "publishing_option": "published" } }, { "id": "202", "type": "media", "attributes": { "duration_in_minutes": 1, } }, { "id": "101", "type": "offers", "attributes": { "price": 100.0, "currency": "USD", "status": "active" } }] } } ``` ## Module attributes Modules are part of Kajabi's course structure: courses contain modules and modules contain lessons * `title` (string) - A required field that represents the name or heading of the module. This is used to: * Identify and display the module in the course outline * Organize related lessons/content * Provide navigation structure in the course * The title must be unique within a course. * `description` (string) - An optional text field that provides additional information about the module's content. This can be used to: * Give students an overview of what they'll learn * Explain the module's objectives * Provide context for the contained lessons * Help students understand the module's purpose in the course structure * `position` (integer) - A numeric field that determines the order of modules within a course. This: * Used for sorting * Allows modules to be reordered * Maintains the course's logical progression * Is used for navigation between modules * Starts at position 1 for the first module * `poster_image_url` (string) - A URL to an image that represents the module visually. This: * Can be uploaded through the Kajabi admin interface * Is used as a thumbnail/preview image * Helps with visual organization of the course * `publishing_option` (string) - Controls the visibility and availability of the module. Options include: * `published` - Module is visible and available to students * `draft` - Module is hidden and not yet available * Can be used with drip settings for timed release * Affects the visibility of contained lessons * Syncs with the course's overall publishing status ## Lesson attributes Lessons can include various types of content: text content (body), videos, audio, quizzes, assessments, and downloads. * `title` (string) - A required field that represents the name or heading of the lesson. This: * Must be present * Has a maximum length of 200 characters * Is used for display and navigation * Can be searched (using pg_search) * Is used in course outlines and navigation * `position` (integer) - A numeric field that determines the order of lessons within a module (category). This: * Usedfor sorting (ranks :sort, column: :position) * Is scoped within each module * Allows lessons to be reordered * Maintains the logical flow of content * Is used for navigation between lessons * `status` (string) - An field that tracks the lesson's processing state: * `ready` - Default state, lesson is ready for use * `duplicating` - Lesson is being copied * `failed` - An error occurred during processing * This is particularly relevant for lessons with media content or during duplication. * `publishing_option` (string) - Controls the visibility and availability of the lesson. Options include: * `draft` - Lesson is hidden and not yet available to students * `published` - Lesson is visible and available (sets publish_at to current time) * `drip` - Lesson becomes available after a specified number of days * `locked` - Lesson is locked until certain conditions are met (e.g., completing previous lessons) ## Media attributes * `duration_in_minutes` (float) - The length of a media file (typically video or audio) in minutes. ## Sparse Fields Use the `fields` parameter to request only specific attributes: ### Only return title and thumbnail_url attributes * `GET /v1/courses/123?fields[courses]=title,thumbnail_url` Response will only include requested fields ```json { "data": { "id": "123", "type": "courses", "attributes": { "title": "Marketing Fundamentals", "thumbnail_url": "https://example.com/thumbnail.jpg" } } } ``` ## Using Multiple Parameters Together You can combine sparse fields and include in a single request: ### Get course details with modules and lessons, showing only specific fields * `GET /v1/courses/123?include=modules,lessons,lessons.media&fields[courses]=title,thumbnail_url&fields[modules]=title&fields[lessons]=title&fields[media]=duration_in_minutes` Response will include related resources with requested fields ```json { "data": { "id": "123", "type": "courses", "attributes": { "title": "Marketing Fundamentals", "thumbnail_url": "https://example.com/thumbnail.jpg" }, "relationships": {} }, "included": [{ "id": "456", "type": "modules", "attributes": { "title": "Marketing Basics" } }, { "id": "789", "type": "lessons", "attributes": { "title": "Marketing Strategies" } }, { "id": "101", "type": "media", "attributes": { "duration_in_minutes": 30 } }] } ``` parameters: - name: id in: path required: true schema: type: string - name: include in: query required: false description: >- Load the related resources, for example ?include=modules,lessons,lessons.media schema: type: string responses: '200': description: Success, shows details of a course content: application/vnd.api+json: schema: $ref: '#/components/schemas/courses_show_response' '401': description: Unauthorized, Authorization header is missing or invalid content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_unauthorized' '403': description: Forbidden, insufficient permission to access the resource content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_forbidden' security: - Bearer: [] components: schemas: courses_show_response: type: object properties: data: type: object properties: id: type: string type: type: string attributes: $ref: '#/components/schemas/courses_attributes' relationships: type: object properties: site: type: object properties: data: $ref: '#/components/schemas/resource_identifier' offers: type: object properties: data: $ref: '#/components/schemas/resource_identifiers' modules: type: object properties: data: $ref: '#/components/schemas/resource_identifiers' lessons: type: object properties: data: $ref: '#/components/schemas/resource_identifiers' links: type: object properties: self: type: string current: type: string included: type: array items: type: object properties: id: type: string type: type: string attributes: anyOf: - $ref: '#/components/schemas/offers_attributes' - $ref: '#/components/schemas/courses_attributes' - $ref: '#/components/schemas/course_modules_attributes' - $ref: '#/components/schemas/course_lessons_attributes' relationships: type: object properties: {} errors_unauthorized: type: object properties: errors: type: array items: $ref: '#/components/schemas/errors_attributes' errors_forbidden: type: object properties: errors: type: array items: $ref: '#/components/schemas/errors_attributes' courses_attributes: type: object properties: created_at: type: string format: date-time readOnly: true description: ISO 8601 date-time, read only title: type: string description: type: - string - 'null' thumbnail_url: type: - string - 'null' required: - title resource_identifier: type: object properties: id: type: string type: type: string required: - id - type resource_identifiers: type: array items: $ref: '#/components/schemas/resource_identifier' offers_attributes: type: object properties: title: type: string description: type: - string - 'null' internal_title: type: - string - 'null' currency: type: string price_in_cents: type: integer payment_type: type: string token: type: string payment_method: type: string price_description: type: string checkout_url: type: string recurring_offer: type: boolean subscription: type: boolean one_time: type: boolean single: type: boolean free: type: boolean image_url: type: - string - 'null' required: - title course_modules_attributes: type: object properties: title: type: string description: type: - string - 'null' position: type: - string - 'null' poster_image_url: type: - string - 'null' publishing_option: type: string course_lessons_attributes: type: object properties: title: type: string position: type: - string - 'null' status: type: string publishing_option: type: string errors_attributes: type: object properties: status: type: string source: type: object nullable: true properties: pointer: type: string title: type: string detail: type: string securitySchemes: Bearer: type: http scheme: bearer ````