> 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 # GetProgram # Package: benefitPrograms # Namespace: ProgramService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/benefit-programs/programs/get-program.md ## Permission Scopes: SCOPE.BENEFIT_PROGRAMS.READ (PII): SCOPE.BENEFIT_PROGRAMS.READ_LIMITED ## Introduction Retrieves a program. --- ## REST API ### Schema ``` Method: getProgram Description: Retrieves a program. URL: https://www.wixapis.com/benefit-programs/v1/programs/{programId} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: programId Method parameters: param name: programId | type: none | required: true Return type: GetProgramResponse - name: program | type: Program | description: Retrieved program. - name: id | type: string | description: Program GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the program is updated. To prevent conflicting changes, the current revision must be specified when updating the program. Ignored when creating a program. - name: createdDate | type: string | description: Date and time the program was created. - name: updatedDate | type: string | description: Date and time the program was updated. - name: programDefinitionId | type: string | description: GUID of the associated program definition. - name: status | type: ProgramStatus | description: Program status. - enum: - ACTIVE: Program is active. - PAUSED: Program is paused. It can be resumed. - ENDED: Program has ended. It can't be resumed. - PROVISIONING: Program is being activated for the first time. This status exists for a short time during processing. - PAUSING: Program is being paused. This status exists for a short time during processing. - RESUMING: Program is being re-activated after being paused. This status exists for a short time during processing. - ENDING: Program is being ended. This status exists for a short time during processing. - name: beneficiary | type: IdentificationData | description: Program beneficiary. - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor that hasn't logged in to the site. - name: memberId | type: string | description: GUID of a site member. - name: wixUserId | type: string | description: GUID of a Wix user. - name: displayName | type: string | description: Program name. You may want to use the same name that's used in the associated program definition, if it exists. - name: namespace | type: string | description: Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created. - name: extendedFields | type: ExtendedFields | description: Custom field data for the program object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - 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). - name: externalId | type: string | description: GUID for the program defined by you. You can use `externalId` to filter queries. - name: programDefinition | type: ProgramDefinitionInfo | description: Associated program definition information. - name: id | type: string | description: Program definition GUID. - name: externalId | type: string | description: Program definition external GUID. ``` ### Examples ### GetProgram ```curl ~~~cURL curl --request GET https://www.wixapis.com/benefit-programs/v1/programs/e5c42e1e-cd10-4210-b483-bb59932b1fa7 \ -H "Content-Type: application/json" \ -H "Authorization: " ~~~ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.benefitPrograms.ProgramService.getProgram(programId) Description: Retrieves a program. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: programId Method parameters: param name: programId | type: string | description: GUID of the program to retrieve. | required: true Return type: PROMISE - name: _id | type: string | description: Program GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the program is updated. To prevent conflicting changes, the current revision must be specified when updating the program. Ignored when creating a program. - name: _createdDate | type: Date | description: Date and time the program was created. - name: _updatedDate | type: Date | description: Date and time the program was updated. - name: programDefinitionId | type: string | description: GUID of the associated program definition. - name: status | type: ProgramStatus | description: Program status. - enum: - ACTIVE: Program is active. - PAUSED: Program is paused. It can be resumed. - ENDED: Program has ended. It can't be resumed. - PROVISIONING: Program is being activated for the first time. This status exists for a short time during processing. - PAUSING: Program is being paused. This status exists for a short time during processing. - RESUMING: Program is being re-activated after being paused. This status exists for a short time during processing. - ENDING: Program is being ended. This status exists for a short time during processing. - name: beneficiary | type: IdentificationData | description: Program beneficiary. - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor that hasn't logged in to the site. - name: memberId | type: string | description: GUID of a site member. - name: wixUserId | type: string | description: GUID of a Wix user. - name: displayName | type: string | description: Program name. You may want to use the same name that's used in the associated program definition, if it exists. - name: namespace | type: string | description: Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created. - name: extendedFields | type: ExtendedFields | description: Custom field data for the program object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - 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). - name: externalId | type: string | description: GUID for the program defined by you. You can use `externalId` to filter queries. - name: programDefinition | type: ProgramDefinitionInfo | description: Associated program definition information. - name: _id | type: string | description: Program definition GUID. - name: externalId | type: string | description: Program definition external GUID. ``` ### Examples ### Get a benefit program ```javascript import { programs } from "@wix/benefit-programs"; async function getProgram() { const response = await programs.getProgram("e5c42e1e-cd10-4210-b483-bb59932b1fa7"); } /* Promise resolves to: * { * "program": { * "id": "e5c42e1e-cd10-4210-b483-bb59932b1fa7", * "revision": "2", * "status": "ACTIVE", * "beneficiary": { "memberId": "...", "identityType": "MEMBER" }, * "namespace": "benefit_programs_app", * "externalId": "myProgram17", * "programDefinition": { "id": "...", "externalId": "myProgramDefinition" } * } * } */ ``` ### getProgram (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 { programs } from '@wix/benefit-programs'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { programs }, // Include the auth strategy and host as relevant }); async function getProgram(programId) { const response = await myWixClient.programs.getProgram(programId); }; ``` ---