> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # GetStep # Package: onlinePrograms # Namespace: StepsService # Method link: https://dev.wix.com/docs/api-reference/business-management/online-programs/steps/get-step.md ## Permission Scopes: Manage Online Programs: SCOPE.CHALLENGES.MANAGE ## Introduction Retrieves a step. Use `descriptionFieldSet` to control how much description content to return. Some returned fields depend on the caller's permissions. --- ## REST API ### Schema ``` Method: getStep Description: Retrieves a step. Use `descriptionFieldSet` to control how much description content to return. Some returned fields depend on the caller's permissions. URL: https://www.wixapis.com/online-programs/v3/steps/{stepId} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: stepId Method parameters: param name: descriptionFieldSet | type: DescriptionFieldSet - enum: STANDARD - Returns the standard step description fields. EXTENDED - Returns additional step description fields when they're available to the caller. param name: stepId | type: none | required: true Return type: GetStepResponse - name: step | type: Step | description: Retrieved step. - ONE-OF: - name: videoOptions | type: VideoOptions | description: Video-specific settings. - ONE-OF: - name: wixVideo | type: WixVideo | description: Video from Wix Video. - name: id | type: string | description: Wix Video GUID. | validation: format GUID - name: paid | type: boolean | description: Whether the Wix Video is paid content. - name: video | type: VideoV2 | description: Video uploaded with Media Manager. - name: id | type: string | description: WixMedia GUID. - name: resolutions | type: array | description: Available resolutions for the video, starting with the optimal resolution. | read-only: true | validation: maxItems 100 - name: url | type: string | description: Video URL. - name: height | type: integer | description: Video height. - name: width | type: integer | description: Video width. - name: format | type: string | description: Video format for example, mp4, hls. - name: filename | type: string | description: Video filename. | read-only: true - name: requiredCompletionPercentage | type: number | description: Percentage of the video that must be watched to complete the step. - name: coverImage | type: Image | description: Cover image for the video. - name: id | type: string | description: WixMedia image GUID. - name: url | type: string | description: Image URL. - name: height | type: integer | description: Original image height. | read-only: true - name: width | type: integer | description: Original image width. | read-only: true - name: altText | type: string | description: Image alt text. - name: filename | type: string | description: Image filename. | read-only: true - name: durationInMilliseconds | type: integer | description: Video duration in milliseconds. | validation: format int32 - name: deleted | type: boolean | description: Whether the uploaded video was deleted from Media Manager. - name: quizOptions | type: QuizOptions | description: Quiz-specific settings. - name: id | type: string | description: Quiz GUID. Provide it when creating a quiz step. After creation, the quiz reference can't be changed. | read-only: true | validation: format GUID, immutable - name: totalQuestions | type: integer | description: Total number of questions in the quiz. | read-only: true - name: passingGrade | type: number | description: Minimum percentage required to pass the quiz. | validation: format double - name: id | type: string | description: Step GUID. | read-only: true | validation: format GUID - name: revision | type: string | description: Revision number, which increments by 1 each time the step is updated. To prevent conflicting changes, the current `revision` must be passed when updating the step. | read-only: true | validation: format int64 - name: createdDate | type: string | description: Date and time the step was created. | read-only: true | validation: format date-time - name: updatedDate | type: string | description: Date and time the step was updated. | read-only: true | validation: format date-time - name: sectionId | type: string | description: Parent section GUID. To move a step within a section or to another section, call `MoveStep`. | read-only: true | validation: format GUID - name: description | type: Description | description: Step title, rich text content, and optional media. - ONE-OF: - name: image | type: Image | description: Image displayed with the step content. - name: video | type: VideoV2 | description: Video displayed with the step content. - name: title | type: string | description: | validation: maxLength 250 - name: details | type: string | description: | validation: maxLength 1000000 - name: ordering | type: number | description: Step position within the section. - name: stepType | type: StepType | description: Type of content in the step. - enum: - ARTICLE: Text-based step. - VIDEO: Step with video content. - QUIZ: Step linked to a quiz. - name: extendedFields | type: ExtendedFields | description: Custom field data for the step object. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). | validation: format map - name: programId | type: string | description: Program GUID. | read-only: true | validation: format GUID ``` ### Examples ### Get a step Retrieves a step and requests the extended description fields. ```curl curl -X GET \ 'https://www.wixapis.com/online-programs/v3/steps/c5f91a8e-1e8b-4f6f-9da2-2d715874e91c?descriptionFieldSet=EXTENDED' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.onlinePrograms.steps.getStep(stepId, options) Description: Retrieves a step. Use `descriptionFieldSet` to control how much description content to return. Some returned fields depend on the caller's permissions. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: stepId Method parameters: param name: options | type: GetStepOptions none - name: descriptionFieldSet | type: DescriptionFieldSet | description: Predefined set of description fields to return. - enum: - STANDARD: Returns the standard step description fields. - EXTENDED: Returns additional step description fields when they're available to the caller. param name: stepId | type: string | description: Step GUID. | required: true | validation: format GUID Return type: PROMISE - ONE-OF: - name: videoOptions | type: VideoOptions | description: Video-specific settings. - ONE-OF: - name: wixVideo | type: WixVideo | description: Video from Wix Video. - name: _id | type: string | description: Wix Video GUID. | validation: format GUID - name: paid | type: boolean | description: Whether the Wix Video is paid content. - name: video | type: string | description: Video uploaded with Media Manager. - name: requiredCompletionPercentage | type: number | description: Percentage of the video that must be watched to complete the step. - name: coverImage | type: string | description: Cover image for the video. - name: durationInMilliseconds | type: integer | description: Video duration in milliseconds. | validation: format int32 - name: deleted | type: boolean | description: Whether the uploaded video was deleted from Media Manager. - name: quizOptions | type: QuizOptions | description: Quiz-specific settings. - name: _id | type: string | description: Quiz GUID. Provide it when creating a quiz step. After creation, the quiz reference can't be changed. | read-only: true | validation: format GUID, immutable - name: totalQuestions | type: integer | description: Total number of questions in the quiz. | read-only: true - name: passingGrade | type: number | description: Minimum percentage required to pass the quiz. - name: _id | type: string | description: Step GUID. | read-only: true | validation: format GUID - name: revision | type: string | description: Revision number, which increments by 1 each time the step is updated. To prevent conflicting changes, the current `revision` must be passed when updating the step. | read-only: true | validation: format int64 - name: _createdDate | type: Date | description: Date and time the step was created. | read-only: true - name: _updatedDate | type: Date | description: Date and time the step was updated. | read-only: true - name: sectionId | type: string | description: Parent section GUID. To move a step within a section or to another section, call `MoveStep`. | read-only: true | validation: format GUID - name: description | type: Description | description: Step title, rich text content, and optional media. - ONE-OF: - name: image | type: string | description: Image displayed with the step content. - name: video | type: string | description: Video displayed with the step content. - name: title | type: string | description: | validation: maxLength 250 - name: details | type: string | description: | validation: maxLength 1000000 - name: ordering | type: number | description: Step position within the section. - name: stepType | type: StepType | description: Type of content in the step. - enum: - ARTICLE: Text-based step. - VIDEO: Step with video content. - QUIZ: Step linked to a quiz. - name: extendedFields | type: ExtendedFields | description: Custom field data for the step object. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). | validation: format map - name: programId | type: string | description: Program GUID. | read-only: true | validation: format GUID ``` ### Examples ### Get a step with its extended description ```javascript import { steps } from "@wix/online-programs"; const step = await steps.getStep( "c5f91a8e-1e8b-4f6f-9da2-2d715874e91c", { descriptionFieldSet: "EXTENDED" }, ); /* Promise resolves to: { "_id": "c5f91a8e-1e8b-4f6f-9da2-2d715874e91c", "revision": "1", "_createdDate": "2026-08-18T09:50:12.557Z", "_updatedDate": "2026-08-18T09:50:12.557Z", "sectionId": "b142d26b-2c56-4b85-9f8d-6bea0920eb4d", "description": { "title": "Welcome to week 1", "details": "Review the weekly plan and complete the first assignment." }, "ordering": 10, "stepType": "ARTICLE", "programId": "9a76e7d5-235a-4821-8f36-2d8bd0e7e9c1" } */ ``` ### getStep (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { steps } from '@wix/online-programs'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { steps }, // Include the auth strategy and host as relevant }); async function getStep(stepId,options) { const response = await myWixClient.steps.getStep(stepId,options); }; ``` ---