NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Memberspot connects to a Nagent workspace with an API key. Once it is connected, agents can call 13 Memberspot actions, such as "Create Login Token", "Find user by email" and "Get user course progress". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Memberspot, with input parameters and output schema.
MEMBERSPOT_CREATE_LOGIN_TOKENTool to generate a one-hour login token for a user. Use when you need to auto-login a user by their UID (token expires after one hour).
Input parameters
The unique ID (uid) of the user to create a login token for. Get the uid from MEMBERSPOT_LIST_USERS or MEMBERSPOT_FIND_USER_BY_MAIL actions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MEMBERSPOT_DELETE_USERSTool to delete one or more users from the platform. Use when you need to remove specified users by their email addresses. Only existing school users are removed; invalid or out-of-school emails are ignored.
Input parameters
List of user email addresses to delete. Must contain at least one email. Only existing school users will be deleted; invalid emails are ignored.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MEMBERSPOT_DELETE_USERS_POSTTool to delete multiple users by email using POST method. Use this if your client does not support DELETE with body. Only existing school users are removed; invalid or out-of-school emails are ignored.
Input parameters
Array of user email addresses to delete. Must contain 1-10 emails. Only existing school users will be deleted; invalid emails are ignored.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MEMBERSPOT_FIND_USER_BY_MAILTool to retrieve a user's details by their email address. Use when you need to look up a user after obtaining their email.
Input parameters
Email address of the user to search for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MEMBERSPOT_GET_USER_COURSE_PROGRESSTool to retrieve user course progress for a specific course and email. Use when you need to check how far a user has progressed through a particular course. Returns details including active posts, completed posts, and user information. Rate limited to 4 requests per second.
Input parameters
Email address of the user to get course progress for.
The course ID to get progress for. Use MEMBERSPOT_LIST_OFFERS or MEMBERSPOT_LIST_USERS to find valid course IDs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MEMBERSPOT_GRANT_USER_OFFER_BY_MAILTool to grant a user access to an offer by email. If the user does not exist, a new user is created automatically.
Input parameters
User's last name (optional).
User's email address. If user does not exist, a new user will be created.
Order ID for the access grant (optional).
User's first name (optional).
Offer ID to grant access to (optional).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MEMBERSPOT_LIST_CUSTOM_USER_PROPERTIESTool to list all defined custom user properties. Use when you need to retrieve metadata of custom user properties after authentication.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MEMBERSPOT_LIST_OFFERSRetrieves all available offers (products/course bundles) from the Memberspot school. Use this to discover offer IDs before granting or revoking user access. Each offer contains course IDs it grants access to and metadata like priority and update time. No parameters required - returns all offers in the school.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MEMBERSPOT_LIST_USER_COURSE_PROGRESSRetrieves paginated list of all course progress for a specific user by email. Use to track user progress across all enrolled courses, including active and completed posts. Rate limited to 4 requests per second.
Input parameters
Email address of the user to retrieve course progress for.
Number of course progress records to return per page. Defaults to 10. Maximum is 100.
Pagination cursor - the course ID from the last item of the previous page. Use to fetch subsequent pages of results.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MEMBERSPOT_LIST_USERSList all users in your Memberspot school with optional filtering and pagination. Use this tool to: - Retrieve all users in your membership platform - Filter users by offer access, course enrollment, or active status - Paginate through large user lists using the nextPage token Returns user details including email, name, creation date, progress, and custom properties. Note: API rate limit is 4 requests per second.
Input parameters
Filter by user status. Set to true for active users only, false for inactive users only. Omit to return all users.
Filter to return only users who have access to this specific offer. Use MEMBERSPOT_LIST_OFFERS to get valid offer IDs.
Filter to return only users enrolled in this specific course.
Number of users to return per page. Defaults to 10. Maximum recommended is 100.
Pagination cursor token from the 'nextPage' field of a previous response. Must be a valid MongoDB ObjectId. Use to fetch subsequent pages of results.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MEMBERSPOT_SET_OFFER_EXPIRESTool to set or remove the expiration date for an offer for a user. Use when you need to grant time-limited access to an offer or remove time limits from an existing offer. When no value is provided for expiresAt, the offer expiration will be removed.
Input parameters
User identifier for whom to set the offer expiration.
Offer ID to set expiration for.
Expiration date in ISO 8601 format (e.g., 2025-12-31T23:59:59.000Z). Set to null or omit to remove expiration.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MEMBERSPOT_SET_ORDER_STATEManages order-based offer access for a user in Memberspot. Use this to activate (grant access), deactivate (revoke access), or delete an order-based offer association. Order IDs typically come from payment providers (Stripe, Copecart, Digistore) after a purchase.
Input parameters
Email address of the user whose order state is to be set.
Whether to activate (true) or deactivate (false) the offer. If omitted, the offer is deleted for the user.
Unique identifier of the order (typically from payment providers like Stripe, Copecart, or Digistore) that grants the user access to an offer.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MEMBERSPOT_SET_USER_OFFER_STATETool to revoke or set the state of a specific offer for a user. Use after confirming whether the user should gain or lose access.
Input parameters
Email address of the user whose offer state is to be set.
Whether to activate (true) or revoke (false) the user's access to the offer.
Identifier of the offer to activate or revoke for the user.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 13 Memberspot actions on Nagent, including "Create Login Token", "Find user by email" and "Get user course progress". Create Login Token: Generate a one-hour login token for a user. Each action is listed on this page with its input parameters and its output.
Memberspot connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create Login Token takes 1 required input: uid. It returns data, error and successful.