Menu

retrieveInvite - User Module Reference

This documentation provides a reference to the retrieveInvite method. This belongs to the User Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

This method retrieves an invite by its ID.

Example#

Code
1const invite = await userModuleService.retrieveInvite(2  "invite_123"3)

Parameters#

idstring
The ID of the invite.
configFindConfig<InviteDTO>Optional
The configurations determining how the invite is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a invite.
sharedContextContextOptional
A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<InviteDTO>
The retrieved invite.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵