Tools
The 999 tools of Memberfy's MCP server, organized by subject (community, content, courses, events, members, sales, subscriptions, finance, certificates, call for papers, downloads and reports), with the minimum role and type of each one, and the rules they all share.
Memberfy's MCP server has 999 tools, which cover every module of the community: the assistant does what the app lets the connected person do, with their role. The assistant picks which one to use from your request on its own; this page and the subject pages are there so you know what it can do, with which role, and how to ask. The names are in English, as the assistant sees them, and they are the same in every language; the title shown in Claude or ChatGPT, and the messages in the responses, come in the language of your registration in the connected community (My Account › Profile, Language; if none is chosen, the community's language).
By role, the list has 981 tools for the owner and the admin, 664 for finance, 629 for the moderator and 474 for the member. The other 18 are SuperAdmin-only, in the Memberfy community.
By subject
| Subject | What you can do | Tools |
|---|---|---|
| Community and structure | The connection's context, opening an app link, creating, editing, reordering and deleting sections and spaces, who sees each one, settings and language, sale notices, e-mail campaigns, e-mail library, default e-mails, workflows (with the automation guide and Variables and keys), sending reputation, custom domain, SMS and WhatsApp and API keys, sending through your Resend account and video signing keys | 167 |
| Content and engagement | Posts and short posts, moving a post, comments, reactions, pinning, search, link previews, gallery, hosted video and media links, classifieds, importing posts from a spreadsheet, engagement, moderation, channel and upvote, scheduled posts and points as currency | 113 |
| Courses | Whole courses, cover, status, modules and lessons (create, edit, move, reorder, delete), enrollment and progress, a course's students and the A single course mode, seats, waitlist and free products | 32 |
| Events | Events, drafts and publishing, tickets, attendance, live streaming, recording, banner and deletion, ticket types and batches | 47 |
| Members | Listing, inviting, importing a spreadsheet, custom fields, changing roles, removing, groups, tags, org chart, surveys and forms, your e-mail preference and your SMS and WhatsApp notices, recognition, feedback, development plans, time tracking, messages and notifications, the welcome and First steps, member referrals, privacy (download your data and delete the account) | 311 |
| Sales and plans | Plans, options, add-ons, products, prices, coupons, downsell and store, as drafts until approval, redeeming a product with points | 28 |
| Subscriptions | Who subscribes to what, CSV, complimentary access, discounts, extensions and cancellations; your own subscriptions and purchases (or your company's), changing your plan, adding an add-on and paying an overdue renewal | 18 |
| Finance | Sales and refunds, customers, statement, balance, payouts and fees | 13 |
| Certificates | Templates, who issues, issuing, resending, revoking and reissuing; your own certificates | 18 |
| Call for papers | The whole cycle: opening the call, tracks and days, owners and reviewers, proposals, scores, decision, negotiation, program and voting | 40 |
| Downloads | Downloads spaces: settings, items, files, the download link, your downloads and the counters | 13 |
| Podcast and Videos | Shows and presenters, episodes with audio, video and chapters, publishing and scheduling with the e-mail's reach, transcripts, numbers, the point where you stopped, comments and the queue | 29 |
| Attendance | The occupancy, I've arrived and I'm leaving, who's here, guests, history, fixing and removing visits, and the front desk kiosk links. | 12 |
| Parcels | Registering letters and packages with a photo, the queue, pickup, return, discard, reopening, deletion and the member's "do I have a parcel?". | 20 |
| Bookings and Scheduling | Finding what is free, booking with a cost in credits, rescheduling, canceling, no-shows, calendar invite, rooms, blocks, price bands and agenda approval. | 34 |
| Networking | Finding people, seeing their times and booking free sessions, joining and leaving the program, accepting and declining, How did it go?, reviews, session types, the request queue, the people in the program and the first-session badges. | 26 |
| Credits | Balance, statement, the company wallet, granting, adjusting and taking back credits, and the community rules (accrual, cancellation window, late cancellation and no-shows). | 9 |
| Visitors | Register, edit and cancel a guest, today's expected guests, find the host, and mark or undo an arrival | 9 |
| Companies | Register, edit and close companies (with the offers and billing details in a coworking), your company, the team, invite by e-mail with acceptance, accept or decline invitations, mark the company admin and remove | 14 |
| Support | Open a ticket with photos, the queue and deadlines, triage, assign, resolve, internal note, cancel, reopen, who answers, and inspection rounds | 32 |
| Reports and charts | Sales, MRR, active members, engagement and the leaderboard, events, courses, one member's activity and the month's dashboard, the engagement statement, visits, purchase funnel, most read content, one post's reads and who is online, ready to become a chart | 14 |
Each tool has a badge: Read-only changes nothing, Changes creates or changes something right away, and Asks to confirm only acts after your yes to a summary.
All tools
Minimum role: the lowest role the tool shows up for. "Any" includes members. Finance is listed separately because it isn't on the same ladder as the other roles.
| Tool | Subject | Minimum role | Type | What it does |
|---|---|---|---|---|
get_community_context | Community and structure | Any | Read-only | Community, role, sections and spaces with ids: the starting point |
get_connection_diagnostics | Community and structure | Admin | Read-only | Whether the assistant's tool list is up to date |
list_spaces | Community and structure | Any | Read-only | Sections and spaces, filterable by module |
list_space_updates | Community and structure | Any | Read-only | What is new in your spaces since your last visit |
open_link | Community and structure | Any | Read-only | Says what a link copied from the app (or an id) is |
create_section | Community and structure | Admin | Changes | Creates a menu section |
create_space | Community and structure | Admin | Changes | Creates a space in a section (and, in Courses, the A single course mode) |
update_space | Community and structure | Admin | Changes | Changes a space's name, description, icon or visibility, or moves it to another section |
update_section | Community and structure | Admin | Changes | Changes a section's name, description or icon, or makes it the home section |
reorder_sections | Community and structure | Admin | Changes | Puts the menu sections in a new order |
reorder_spaces | Community and structure | Admin | Changes | Puts a section's spaces in a new order |
get_space_access | Community and structure | Team | Read-only | Who gets into a space or a section: groups, products, plans and badges |
update_space_access | Community and structure | Admin | Changes | Who sees a space or a section, and who posts in the space |
delete_section | Community and structure | Admin | Asks to confirm | Deletes an empty section |
delete_space | Community and structure | Admin | Asks to confirm | Deletes a space |
get_community_settings | Community and structure | Admin | Read-only | The community's settings: name, colors, images, SEO, language, entry |
update_community_settings | Community and structure | Admin | Changes | Changes name, colors, logo, favicon, SEO, language and entry rules |
update_community_appearance | Community and structure | Admin | Asks to confirm | Changes the logo for dark backgrounds (the mode and the menu belong to the theme) |
list_theme_presets | Community and structure | Admin | Read-only | The gallery's ready-made themes |
list_community_themes | Community and structure | Admin | Read-only | The community's saved themes, with the active one |
get_community_theme | Community and structure | Admin | Read-only | One theme with all its values (without an id, the active one) |
create_community_theme | Community and structure | Admin | Changes | Saves a theme from a ready-made one, a saved one or the logo proposal |
update_community_theme | Community and structure | Admin | Changes | Changes a theme; on the active one, the community changes right away |
activate_community_theme | Community and structure | Admin | Asks to confirm | Switches the theme for the whole community |
restore_community_theme | Community and structure | Admin | Asks to confirm | Takes a theme back to its original values |
delete_community_theme | Community and structure | Admin | Asks to confirm | Deletes a saved theme |
suggest_community_theme_from_logo | Community and structure | Admin | Changes | Proposes a theme with the logo's colors, without saving (1 AI use) |
get_notification_settings | Community and structure | Admin | Read-only | The e-mail that receives sale notices |
update_notification_settings | Community and structure | Admin | Changes | Changes the sale notices e-mail and turns the recovery e-mail on or off |
list_posts | Content and engagement | Any | Read-only | The feed, with comments and reactions |
search_content | Content and engagement | Any | Read-only | Finds posts, events, courses, sections, spaces and calls by title |
list_comments | Content and engagement | Any | Read-only | A post's comments |
create_post | Content and engagement | Any | Changes | Publishes a post |
preview_link | Content and engagement | Any | Read-only | Shows how a link will look in the post: player or card |
update_post | Content and engagement | Author, moderator or finance | Changes | Edits a post's title, text, cover or pin |
delete_post | Content and engagement | Author, moderator or finance | Asks to confirm | Deletes a post, with confirmation |
move_post | Content and engagement | Moderator or finance | Changes | Moves a post to another Content or Feed space |
create_short_post | Content and engagement | Member (not finance) | Changes | Publishes a short post, with no title, in a Feed |
analyze_content_import | Content and engagement | Admin | Changes | Reads a spreadsheet of posts and suggests where each column goes |
preview_content_import | Content and engagement | Admin | Read-only | The post import summary and the first 10 rows, saving nothing |
start_content_import | Content and engagement | Admin | Changes | Imports the spreadsheet's posts, with their original date and silently |
get_content_import | Content and engagement | Admin | Read-only | Progress and report of a post import |
create_poll | Content and engagement | Moderator (not finance) | Changes | Publishes a poll in a Feed (the question is the text) or in a Content space (the question is the title) |
get_poll | Content and engagement | Any | Read-only | The results: votes and percentage per option, how many voted, the deadline and what you chose |
vote_poll | Content and engagement | Any | Changes | Votes in your name, by option id or text; voting again replaces the vote |
retract_poll_vote | Content and engagement | Any | Changes | Removes your vote while the poll is open |
update_poll | Content and engagement | Moderator (not finance) | Asks to confirm when the options change | Changes the options, multiple choice and the deadline |
close_poll | Content and engagement | Moderator (not finance) | Asks to confirm | Closes the poll now, with no way back |
list_poll_votes | Content and engagement | Moderator (not finance) | Read-only | Who voted for what, with a filter by option |
create_comment | Content and engagement | Any | Changes | Comments or replies |
update_comment | Content and engagement | Author, moderator or finance | Changes | Edits a comment's text |
delete_comment | Content and engagement | Author, moderator or finance | Asks to confirm | Deletes a comment, with confirmation |
remove_comment_video | Content and engagement | Author, moderator or finance | Asks to confirm | Removes a comment's Drop; the comment keeps its text |
set_video_poster | Content and engagement | Any | Changes | Chooses the cover of a hosted video (Drop, post video or recording) from an image |
set_video_cover_frame | Content and engagement | Any | Changes | Picks a hosted video's cover from the video's own frames |
remove_video_poster | Content and engagement | Any | Asks to confirm | Removes the chosen cover; the automatic one comes back |
create_drop_description | Content and engagement | Any | Changes | Writes the text of a post, short post or comment from what the person said in the Drop |
get_drop_description | Content and engagement | Any | Read-only | The state and text of a create_drop_description request |
add_reaction | Content and engagement | Any | Changes | Reacts with an emoji |
pin_post | Content and engagement | Moderator or finance | Changes | Pins or unpins in the feed |
add_gallery_image | Content and engagement | Any | Changes | Adds an image to a Gallery space |
add_gallery_images | Content and engagement | Any | Changes | Adds up to 20 images to a gallery, with a result for each |
list_gallery_images | Content and engagement | Any | Read-only | A gallery's images, with author and reactions |
update_gallery_image | Content and engagement | Author, moderator or finance | Changes | Changes an image's title or description |
react_to_gallery_image | Content and engagement | Any | Changes | Reacts to a gallery image |
delete_gallery_image | Content and engagement | Author, moderator or finance | Asks to confirm | Deletes a gallery image |
get_leaderboard | Content and engagement | Any | Read-only | The top of the leaderboard |
get_my_points | Content and engagement | Any | Read-only | Your points and your position on the leaderboard |
get_ranking_rules | Content and engagement | Admin | Read-only | Whether engagement is on, and the points per action |
update_ranking_rules | Content and engagement | Admin | Changes | Turns it on or off and changes the points |
get_ranking_levels | Content and engagement | Admin | Read-only | The community's levels, with the minimum points and the activity each one asks for in the week |
update_ranking_levels | Content and engagement | Admin | Asks to confirm | Saves the levels and requirements, with a preview of how many move up and down |
get_level_progress | Content and engagement | Any | Read-only | What is left this week to stay at or move up a level; the team sees any member's |
list_moderation_queue | Content and engagement | Moderator or finance | Read-only | What is waiting for approval |
moderate_item | Content and engagement | Moderator or finance | Changes | Approves or rejects an item in the queue |
list_courses | Courses | Any | Read-only | The community's courses |
list_my_courses_in_progress | Courses | Any | Read-only | Your courses in progress and the lesson to continue |
get_course | Courses | Any | Read-only | A course with its modules and lessons |
create_course | Courses | Admin | Changes | Space, course, modules, lessons and the product, in one go |
update_course | Courses | Admin | Changes | Edits a course's title, level, status and cover |
create_course_module | Courses | Admin | Changes | Adds a module to a course |
create_lesson | Courses | Admin | Changes | Adds a lesson to a module |
update_course_module | Courses | Admin | Changes | Renames a module or changes its position |
update_lesson | Courses | Admin | Changes | Changes a lesson, or moves it to another module |
list_course_enrollments | Courses | Moderator or finance | Read-only | A course's students, with their progress |
reorder_course_modules | Courses | Admin | Changes | Puts a course's modules in a new order |
reorder_lessons | Courses | Admin | Changes | Puts a module's lessons in a new order |
delete_course_module | Courses | Admin | Asks to confirm | Deletes a module with its lessons |
delete_lesson | Courses | Admin | Asks to confirm | Deletes a lesson |
delete_course | Courses | Admin | Asks to confirm | Deletes a course |
enroll_in_course | Courses | Member (not finance) | Changes | Enrolls you in a published course |
enroll_member_in_course | Courses | Moderator | Changes | Enrolls someone else in a free course |
complete_lesson | Courses | Member (not finance) | Changes | Records your progress in a lesson |
rate_lesson | Courses | Member (not finance) | Changes | Rates a lesson from 1 to 5, with an optional comment |
get_course_ratings | Courses | Moderator or finance | Read-only | The average, distribution and comments of a course's lesson ratings |
list_events | Events | Any | Read-only | Upcoming, past, your own or all events |
list_event_attendees | Events | Any | Read-only | Who RSVP'd to an event |
create_event | Events | Moderator (with a ticket, admin) | Changes | Space, event and the ticket, in one go, published or as a draft |
update_event | Events | Moderator or finance | Changes | Edits only the fields sent of an event or draft, and the banner |
publish_event | Events | Moderator or finance | Asks to confirm | Publishes an event draft, with or without an e-mail notice |
start_live_stream | Events | Moderator or finance | Changes | Marks the event as live, with the stream link |
stop_live_stream | Events | Moderator or finance | Changes | Ends the live stream |
rsvp_event | Events | Member (not finance) | Changes | Says whether you're going: going, maybe or not going |
delete_event | Events | Admin | Asks to confirm | Deletes an event |
list_members | Members | Moderator or finance | Read-only | Members with role and join date; filters who was active or joined in a period |
invite_member | Members | Admin | Changes | Invites one person, with role, groups and tags |
invite_members | Members | Admin | Changes | Invites up to 100 people at once, with the result line by line |
update_member_role | Members | Admin | Changes | Changes a member's role |
remove_member | Members | Admin | Asks to confirm | Removes a person from the community |
list_signup_requests | Members | Admin | Read-only | The join requests in the queue |
approve_signup_request | Members | Admin | Changes | Approves up to 100 join requests at once |
reject_signup_request | Members | Admin | Asks to confirm | Rejects join requests, with a reason |
list_groups | Members | Moderator or finance | Read-only | Groups, with color, leader, parent group and how many people |
create_group | Members | Moderator or finance | Changes | Creates a member group |
update_group | Members | Moderator or finance | Changes | Renames or changes a group |
delete_group | Members | Moderator or finance | Asks to confirm | Deletes a group; the people stay in the community |
update_group_members | Members | Admin | Changes | Adds or removes people from a group |
list_tags | Members | Moderator or finance | Read-only | Tags in use, with color and how many people |
update_member_tags | Members | Moderator or finance | Changes | Tags or untags one or more people |
update_tag | Members | Moderator or finance | Changes | Renames a tag or changes its color |
delete_tag | Members | Moderator or finance | Asks to confirm | Removes a tag from everyone |
get_org_chart | Members | Moderator or finance | Read-only | Who reports to whom, with the groups |
set_manager | Members | Admin | Changes | Sets who a person reports to |
get_my_team | Members | Any | Read-only | Whether you lead anyone, who reports to you and whether there are indirect reports |
list_activity_logs | Members | Admin | Read-only | Who did what: team, assistant, members and API keys |
list_logs | Members | Admin or finance (finance: financial only) | Read-only | The community's Logs: every type of record |
get_my_data_export | Members | Any | Read-only | Your data export: the status, how long it lasts and when you can ask for another |
export_my_data | Members | Any | Asks to confirm | Asks for a ZIP with your data; the link arrives by e-mail only |
export_member_data | Members | Admin | Asks to confirm | Asks for a member's data export, at their request; the link goes to their e-mail |
get_my_account_deletion | Members | Any | Read-only | Your account deletion request and the effective date |
delete_my_account | Members | Any (not the owner) | Asks to confirm | Requests the deletion of your account in this community, with the password; disconnects the assistant |
cancel_my_account_deletion | Members | Any | Asks to confirm | Cancels the deletion of your account |
erase_member_data | Members | Admin | Asks to confirm | Erases a member's data, at their request, with no period to change your mind |
list_plans | Sales and plans | Admin or finance | Read-only | Plans, options and add-ons |
list_products | Sales and plans | Admin or finance | Read-only | Billing options and products, with price and status |
list_coupons | Sales and plans | Admin or finance | Read-only | Coupons with status and usage |
create_product | Sales and plans | Admin | Changes | Creates a product or billing option, as a draft |
create_plan | Sales and plans | Admin | Changes | Options, plan and add-ons, in one go |
publish_product | Sales and plans | Admin | Changes | Puts a product on sale |
unpublish_product | Sales and plans | Admin | Changes | Takes a product off sale |
update_price | Sales and plans | Admin | Asks to confirm | Changes a price, with confirmation |
create_coupon | Sales and plans | Admin | Asks to confirm | Creates a coupon, with confirmation |
update_plan | Sales and plans | Admin | Changes | Changes a plan's name, address, visibility, options, add-ons and images |
update_product | Sales and plans | Admin | Changes | Changes title, spaces, stock, installments, trial, direct link and images |
update_products | Sales and plans | Admin | Changes | Edits up to 20 products at once; the price asks for confirmation |
update_plans | Sales and plans | Admin | Changes | Edits up to 20 plans at once |
update_coupon_status | Sales and plans | Admin | Asks to confirm | Pauses or reactivates a coupon |
update_coupon | Sales and plans | Admin | Asks to confirm | Changes a coupon's name, discount, duration, limits, validity and products |
delete_coupon | Sales and plans | Admin | Asks to confirm | Deletes a coupon |
get_coupon_usage | Sales and plans | Admin or finance | Read-only | Who used a coupon |
list_downsell_offers | Sales and plans | Admin | Read-only | A plan's last-chance offers, with conversion |
create_downsell_offer | Sales and plans | Admin | Asks to confirm | Creates a last-chance offer |
update_downsell_offer | Sales and plans | Admin | Asks to confirm | Changes or pauses a last-chance offer |
delete_downsell_offer | Sales and plans | Admin | Asks to confirm | Deletes a last-chance offer |
delete_product | Sales and plans | Admin | Asks to confirm | Deletes a product or billing option |
delete_plan | Sales and plans | Admin | Asks to confirm | Deletes a plan |
reorder_plans | Sales and plans | Admin | Changes | Puts the plans in a new order on the pricing page |
get_storefront | Sales and plans | Admin | Read-only | What a Store space shows |
update_storefront | Sales and plans | Admin | Changes | Chooses a Store's products and plans |
list_subscriptions | Subscriptions | Admin or finance | Read-only | Subscriptions with status, amount and next charge |
cancel_subscription | Subscriptions | Admin or finance | Asks to confirm | Cancels a member's subscription, with confirmation |
get_subscription | Subscriptions | Admin or finance | Read-only | One subscription, with charges and next charge |
create_manual_subscription | Subscriptions | Admin or finance | Asks to confirm | Complimentary or future charge, without checkout |
update_subscription | Subscriptions | Admin or finance | Asks to confirm | Discount, extend, add-ons, reactivate, payment link |
export_subscriptions_csv | Subscriptions | Admin or finance | Read-only | The subscriptions as CSV, with the same filters |
list_my_subscriptions | Subscriptions | Any | Read-only | Your subscriptions |
get_my_subscription | Subscriptions | Any | Read-only | One of your subscriptions, with since when it is past due and the history |
list_my_purchases | Subscriptions | Any | Read-only | Your one-time purchases |
manage_my_subscription | Subscriptions | Any | Asks to confirm | Cancels, pauses, resumes or reactivates your subscription |
quote_plan_change | Subscriptions | Any | Read-only | How much it costs and what changes when moving to another plan, with the add-ons |
change_my_plan | Subscriptions | Any | Asks to confirm | Changes your plan, with the add-ons in the same change: now, charging the difference to the saved card or by PIX or boleto (the plan changes after the payment), or at the end of the period |
get_scheduled_plan_change | Subscriptions | Any | Read-only | The plan change scheduled for the end of the period |
cancel_scheduled_plan_change | Subscriptions | Any | Asks to confirm | Undoes the scheduled plan change |
get_sales_summary | Finance | Admin or finance | Read-only | Revenue, monthly series, revenue by product and subscribers (gross, refunds, chargebacks and net, by currency) |
list_customers | Finance | Admin or finance | Read-only | Who pays and how much they've paid |
list_purchases | Finance | Admin or finance | Read-only | The sales, with the buyer, the amount, the status and the refund. |
get_purchase | Finance | Admin or finance | Read-only | One sale, with all its refunds and its timeline. |
refund_purchase | Finance | Admin or finance | Asks to confirm | Refunds a sale, choosing whether access continues, with confirmation. |
list_abandoned_carts | Finance | Admin or finance | Read-only | Who opened the checkout and did not buy, and who came back and paid. |
list_ledger_entries | Finance | Admin or finance | Read-only | Statement entries |
get_balance | Finance | Admin or finance | Read-only | Balance per currency: available, pending (with the release dates), held, owed and how much you can withdraw |
list_payouts | Finance | Admin or finance | Read-only | Payouts and their status |
simulate_fee | Finance | Admin | Read-only | How much the community receives from a sale |
request_payout | Finance | Admin | Asks to confirm | Requests a payout, with confirmation |
cancel_payout | Finance | Admin | Asks to confirm | Cancels a pending payout, with confirmation |
list_certificate_templates | Certificates | Moderator, finance or admin | Read-only | A Certificates space's templates |
get_certificate_template | Certificates | Moderator, finance or admin | Read-only | One template, with the preview as an image |
create_certificate_template | Certificates | Moderator, finance or admin | Changes | Creates a template, from the platform default or with the brand's art |
update_certificate_template | Certificates | Moderator, finance or admin | Changes | Changes texts, signers, boxes and the artwork |
activate_certificate_template | Certificates | Moderator, finance or admin | Changes | Activates or archives a template |
issue_certificate | Certificates | Moderator, finance or admin | Changes | Issues to people, groups and tags, after a dry run |
list_issued_certificates | Certificates | Moderator, finance or admin | Read-only | The issued ones, with status and search |
revoke_certificate | Certificates | Admin | Asks to confirm | Revokes a certificate |
reissue_certificate | Certificates | Admin | Changes | Issues it again with the current name |
delete_certificate | Certificates | Admin | Asks to confirm | Deletes a revoked or failed one |
duplicate_certificate_template | Certificates | Moderator, finance or admin | Changes | Copies a template as a new draft |
update_certificate_space_settings | Certificates | Admin | Changes | Who issues in the space: the team or only admins |
resend_certificate_email | Certificates | Moderator, finance or admin | Changes | Sends the certificate e-mail again |
retry_certificate | Certificates | Moderator, finance or admin | Changes | Retries a certificate that failed |
list_my_certificates | Certificates | Any | Read-only | Your certificates, with code and links |
set_certificate_indexing | Certificates | Any | Changes | Shows or hides one of your certificates in search engines |
list_calls_for_papers | Call for papers | Any | Read-only | A space's calls, with status |
get_call_space_settings | Call for papers | Any | Read-only | How the space works: one call or several, who opens them |
update_call_space_settings | Call for papers | Admin | Changes | Changes the space's mode and who can open a call |
get_call_for_papers | Call for papers | Any | Read-only | A call with dates, tracks, days, owners and what you can do |
create_call_for_papers | Call for papers | Whoever can open one | Changes | Opens a call as a draft, with tracks, days and banner |
update_call_for_papers | Call for papers | Team or owner | Changes | Edits text, dates, formats, costs, fee and images |
update_call_status | Call for papers | Team or owner | Changes | Publishes, unpublishes, closes or reopens |
delete_call_for_papers | Call for papers | Team or owner | Asks to confirm | Deletes the call, with tracks and proposals |
add_call_track | Call for papers | Team or owner | Changes | Adds a track |
update_call_track | Call for papers | Team or owner | Changes | Renames a track or changes its purpose |
delete_call_track | Call for papers | Team or owner | Asks to confirm | Removes a track |
add_call_event_date | Call for papers | Team or owner | Changes | Adds a day to the event |
update_call_event_date | Call for papers | Team or owner | Changes | Changes a day's times |
delete_call_event_date | Call for papers | Team or owner | Asks to confirm | Removes a day from the event |
add_call_owner | Call for papers | Team or owner | Changes | Invites someone to be an owner of the call |
remove_call_owner | Call for papers | Team or owner | Asks to confirm | Removes an owner |
list_track_reviewers | Call for papers | Team or owner | Read-only | A track's reviewers |
invite_track_reviewer | Call for papers | Team or owner | Changes | Makes someone a reviewer for a track |
remove_track_reviewer | Call for papers | Team or owner | Asks to confirm | Removes a reviewer |
list_my_call_invitations | Call for papers | Any | Read-only | Your pending invitations, as owner or reviewer |
respond_to_call_invitation | Call for papers | Any | Changes | Accepts or declines one of your invitations |
list_speakers | Call for papers | Team or owner | Read-only | Who has already proposed in the community |
invite_speaker | Call for papers | Team or owner | Changes | Invites someone to propose |
list_proposals | Call for papers | Depends on your role in the call | Read-only | The proposals, with status, track and scores |
get_proposal | Call for papers | Owners, the track's reviewers and the proposer | Read-only | One proposal, with the reviews and the negotiation |
list_my_reviews | Call for papers | Reviewer | Read-only | Your review queue |
review_proposal | Call for papers | The track's reviewer | Changes | Scores a proposal from 1 to 5 |
get_review_progress | Call for papers | Team or owner | Read-only | How the review is going, against the minimum |
get_proposal_reviews | Call for papers | Owners; reviewers after reviewing | Read-only | A proposal's scores and the consensus |
decide_proposal | Call for papers | Team or owner | Changes | Accepts or rejects a proposal |
negotiate_proposal | Call for papers | Team or owner | Changes | Counter-offer, withdraw, accept or end the negotiation |
confirm_proposal | Call for papers | Team or owner | Changes | Confirms the accepted proposal in the program |
list_votable_proposals | Call for papers | Whoever can vote | Read-only | The ballot: what you can vote on and your vote |
vote_on_proposal | Call for papers | Whoever can vote | Changes | Votes from 1 to 5, or removes the vote |
get_vote_results | Call for papers | Depends on the call | Read-only | The result, as far as the call shows it |
list_my_proposals | Call for papers | Any | Read-only | Your proposals, with status |
submit_proposal | Call for papers | Any member | Changes | Submits a proposal to an open call |
update_proposal | Call for papers | The proposer | Changes | Edits the draft proposal and submits it |
withdraw_proposal | Call for papers | The proposer | Asks to confirm | Withdraws the proposal from the call |
respond_to_counter_offer | Call for papers | The proposer | Changes | Accepts the counter-offer or answers with another one |
sales_report | Reports and charts | Admin or finance | Read-only | Sales by day, week or month, by plan, product or payment method, and the total since the first sale |
subscriptions_report | Reports and charts | Admin or finance | Read-only | MRR, new and canceled subscriptions, churn, courtesies and downsell |
members_report | Reports and charts | Moderator or finance | Read-only | New, active and inactive members, by group and by tag |
engagement_report | Reports and charts | Moderator or finance | Read-only | Posts, comments, reactions, the most engaged, unanswered posts and the engagement points |
events_report | Reports and charts | Moderator or finance | Read-only | Events and how many answered going, maybe and not going |
courses_report | Reports and charts | Moderator or finance | Read-only | Enrollments, completions and progress per course |
member_activity | Reports and charts | Admin | Read-only | What one person did: counts, engagement points and links |
community_overview | Reports and charts | Moderator or finance | Read-only | This month against last month, in one call |
get_dashboard | Reports and charts | Moderator or finance | Read-only | The community's day, as in the Dashboard; money only for those who see money |
list_engagement_activities | Reports and charts | Moderator or finance | Read-only | The engagement statement, line by line |
analytics_report | Reports and charts | Admin (finance, only the funnel) | Read-only | Visits, pages, traffic sources, the purchase funnel and the most read content |
get_post_metrics | Reports and charts | Author or admin | Read-only | Reads, expansions, clicks and most clicked domains of a post |
get_online_now | Reports and charts | Admin | Read-only | Who is in the app right now |
react_to_comment | Content and engagement | Member (not finance) | Changes | Reacts to a comment with an emoji |
get_feed_stats | Content and engagement | Any | Read-only | The home page numbers, and yours |
get_feed_highlights | Content and engagement | Any | Read-only | The Feed's side column: upcoming events, trending posts, new members and leaderboard |
get_space_highlights | Content and engagement | Any | Read-only | The tags and what's trending in a Content space |
get_ranking_dashboard | Content and engagement | Any | Read-only | The engagement page: leaderboard, levels and rules |
list_my_points_history | Content and engagement | Any | Read-only | Your points history, action by action |
recalculate_member_points | Content and engagement | Admin | Changes | Recalculates a member's points |
adjust_member_points | Content and engagement | Admin | Changes | Adds or takes away someone's points, with the reason |
list_badges | Content and engagement | Admin | Read-only | The badge catalog, with how many people hold each one |
get_badge | Content and engagement | Admin | Read-only | A badge, with who holds it |
create_badge | Content and engagement | Admin | Changes | Creates a badge, with an image |
update_badge | Content and engagement | Admin | Changes | Changes the name, description, image or who sees it |
delete_badge | Content and engagement | Admin | Asks to confirm | Removes a badge from the catalog |
award_badge | Content and engagement | Admin | Changes | Gives a badge to up to 100 people |
revoke_badge | Content and engagement | Admin | Asks to confirm | Takes a badge back from someone, without notice |
list_member_badges | Content and engagement | Any | Read-only | A member's badges |
list_event_categories | Events | Any | Read-only | The event categories |
register_member_for_event | Events | Moderator | Changes | Registers someone else for a free event |
list_storefront_products | Sales and plans | Any | Read-only | The products of a Store, as you see them |
list_certificate_fonts | Certificates | Moderator, finance or admin | Read-only | The fonts a template can use |
get_certificate_batch | Certificates | Moderator, finance or admin | Read-only | The progress of a batch issue |
get_member | Members | Any | Read-only | A member's profile |
update_member | Members | Admin | Changes | Edits another member |
update_me | Members | Any | Changes | Edits yourself, in this community |
update_my_profile | Members | Any | Changes | Edits your member page: cover, company, country, languages, links, experience and privacy |
list_member_page_activity | Members | Any | Read-only | The Activity tab of a member's page |
update_avatar | Members | Any | Changes | Sets or removes a profile picture, by link or file |
list_member_fields | Members | Moderator or finance | Read-only | The community's custom fields |
create_member_field | Members | Admin | Changes | Creates a custom field |
update_member_field | Members | Admin | Changes | Changes a field's name, type, options or required flag |
reorder_member_fields | Members | Admin | Changes | Puts the fields in a new order |
delete_member_field | Members | Admin | Asks to confirm | Deletes a field; the values are kept |
update_member_field_values | Members | Any (your own); moderator for other people's | Changes | Fills in a person's field values |
analyze_member_import | Members | Admin | Changes | Reads a spreadsheet and suggests where each column goes |
preview_member_import | Members | Admin | Read-only | The import summary, saving nothing |
start_member_import | Members | Admin | Asks to confirm | Imports and sends the invitations |
get_member_import | Members | Admin | Read-only | An import's progress and report |
list_member_imports | Members | Admin | Read-only | The import history |
get_member_import_file | Members | Admin | Read-only | The original file or the CSV of skipped rows |
withdraw_from_community | Members | Any (only the person themself) | Asks to confirm | An imported person declines the invite and leaves |
list_survey_templates | Members | Admin | Read-only | The survey templates (NPS, satisfaction, event, course, eNPS, blank), with sections and questions |
list_surveys | Members | Admin | Read-only | The surveys (or only those of a space_id), with the space, status, mode, recipients, responses and the public link |
get_survey | Members | Admin | Read-only | One survey, with the space, sections, questions and public link |
create_survey | Members | Admin | Changes | Creates a draft survey in a Surveys space (space_id), from a template and/or with your own sections and questions |
update_survey | Members | Admin | Changes | Edits the whole draft (and moves it to another Surveys space); once open, only title, introduction, deadline and public link |
preview_survey_audience | Members | Admin | Read-only | How many people have access to the space today (by space_id or by the survey), with up to 10 names |
open_survey | Members | Admin | Asks to confirm | Opens the survey: freezes who has access to the space, sends each of them an e-mail invitation and returns the recipients and the public address |
close_survey | Members | Admin | Asks to confirm | Closes the survey now, for good |
delete_survey | Members | Admin | Asks to confirm | Deletes the survey; the link stops working |
get_survey_results | Members | Admin | Read-only | The aggregated results, with one filter (group, tag, company or origin; anonymous: origin only) |
list_survey_responses | Members | Admin | Read-only | Who answered what and when (identified surveys only) |
export_survey_csv | Members | Admin | Read-only | The responses as CSV, the same file as the app |
get_my_email_preferences | Members | Any | Read-only | Your e-mail preference in this community: each category, on or off, and the shortcut |
update_my_email_preferences | Members | Any | Changes | Changes your preference: a shortcut (receive everything, block announcements, block all) or categories |
get_my_notice_preferences | Members | Any | Read-only | Your e-mail, SMS and WhatsApp notices in this community |
update_my_notice_preferences | Members | Any | Changes | Turns SMS and WhatsApp on or off, and the categories |
list_my_contact_consents | Members | Any | Read-only | Your SMS and WhatsApp consents |
request_phone_verification | Members | Any | Changes | Sends the verification code to your phone |
confirm_phone_verification | Members | Any | Changes | Verifies your phone with the code |
list_member_contact_consents | Members | Admin | Read-only | A member's SMS and WhatsApp consents |
attest_contact_consent | Members | Admin | Asks to confirm | Records the SMS or WhatsApp consent the community declares it collected |
list_my_pending_surveys | Members | Any | Read-only | The open surveys waiting for your answer, with the link to answer in the app |
list_forms | Members | Any | Read-only | The forms (or only those of a space_id): whoever manages them sees all of them, with the link and the submissions by status; the others, only the ones open to them |
get_form | Members | Any | Read-only | A form as whoever manages it sees it: settings, responsibles, steps and fields |
get_forms_space_settings | Members | Any | Read-only | The mode of the Forms space (one or several) and whether you can create in it |
update_forms_space_settings | Members | Admin | Changes | Switches the space's mode: one form or several |
create_form | Members | Any | Changes | Creates a draft form, with steps and fields of the 13 types (creating follows the space's Who can post) |
update_form | Members | Any | Changes | Edits the form in any status; the visitor and save-as-member options belong to the team |
publish_form | Members | Any | Changes | Publishes; with dry_run, it first shows how many get the notice e-mail and what each submission does |
close_form | Members | Any | Changes | Closes the form: the link stops taking submissions |
reopen_form | Members | Any | Changes | Reopens a closed form |
delete_form | Members | Any | Asks to confirm | Deletes the form; the link goes offline and the submissions stay stored |
list_form_submissions | Members | Any | Read-only | The submissions, with filters by status, origin, period and search (whoever created it, the team and the responsibles) |
get_form_submission | Members | Any | Read-only | One submission, with all the answers and the proof of consent |
update_form_submission_status | Members | Any | Changes | Changes the submission's status: new, in contact or done |
delete_form_submission | Members | Any | Asks to confirm | Deletes a submission |
export_form_submissions_csv | Members | Any | Read-only | The submissions as CSV, the same file as the app |
get_form_to_fill | Members | Any | Read-only | A published form as whoever fills it in sees it, with the values that come from the profile |
submit_form | Members | Any | Changes | Submits the form on your behalf; the consent only with your yes |
list_recognitions | Members | Any | Read-only | The Recognition wall, with a filter by person ("me", name, e-mail or id) and by value (value) |
get_recognition | Members | Any | Read-only | One recognition, with reactions and comments |
search_recognition_recipients | Members | Any | Read-only | Who can be recognized (has access to the space), by name |
create_recognition | Members | Any | Changes | Recognizes 1 to 20 people, with a message and an optional value; dry_run shows first who gets the e-mail |
react_to_recognition | Members | Any | Changes | Reacts with an emoji, or removes the reaction |
create_recognition_comment | Members | Any | Changes | Comments on or replies in a recognition |
list_company_values | Members | Any | Read-only | The community values, active and deactivated |
delete_recognition | Members | Author or team | Asks to confirm | Deletes a recognition; the points it gave are taken back |
delete_recognition_comment | Members | Author or team | Asks to confirm | Deletes a comment on a recognition |
create_company_value | Members | Admin | Changes | Adds a community value |
update_company_value | Members | Admin | Changes | Changes a value's name or description, or deactivates it (active: false) |
reorder_company_values | Members | Admin | Changes | Puts the values in an order |
get_recognition_dashboard | Members | Admin | Read-only | Recognitions made, people who recognized and people recognized, in a period, with the by-value block |
get_recognition_card | Members | Any (author, people recognized and team) | Read-only | The recognition's card as a PNG image, to share |
list_recognition_types | Members | Any | Read-only | The recognition types, with label, phrase, art and whether each is on |
update_recognition_type | Members | Admin | Changes | Turns a recognition type on or off; turning off asks for confirmation |
upload_recognition_type_art | Members | Admin | Changes | Uploads a type's own art (URL or image); replacing own art that already exists asks for confirmation |
remove_recognition_type_art | Members | Admin | Asks to confirm | Puts the type back on the default art, the same in every community |
list_feedbacks | Members | Any | Read-only | Your feedback received or sent (box) |
get_feedback | Members | Any (only your own) | Read-only | One of your feedbacks, with the text |
search_feedback_people | Members | Any | Read-only | Who can give or receive feedback (has access to the space), by name |
create_feedback | Members | Any | Changes | Gives feedback to a colleague (text in Markdown); dry_run shows first who gets the notice |
thank_feedback | Members | Any (the recipient) | Changes | Thanks the author for a feedback received |
list_feedback_requests | Members | Any | Read-only | The requests asked of you or by you, with a status filter |
get_feedback_request | Members | Any (only your own) | Read-only | One of your requests |
create_feedback_request | Members | Any | Changes | Asks a colleague for feedback, with an optional message; dry_run shows first who gets the notice |
answer_feedback_request | Members | Any (the person asked) | Changes | Answers a request with a feedback |
decline_feedback_request | Members | Any (the person asked) | Changes | Declines a request, with no e-mail |
delete_feedback | Members | Any (the author) | Asks to confirm | Deletes your feedback; it is gone for both |
cancel_feedback_request | Members | Any (the requester) | Asks to confirm | Cancels your pending request |
get_feedback_dashboard | Members | Admin | Read-only | The space's numbers, by period and group, with the by-theme block, with no text at all; as CSV with format: csv |
list_feedback_themes | Members | Any | Read-only | The community's themes and behaviors (include_inactive lets the team see the deactivated ones) |
create_feedback_about_request | Members | Any (the person's direct leader; the team, about anyone) | Changes | Asks colleagues for feedback about a direct report (up to the space's limit); dry_run shows who gets the notice and the limit |
get_feedback_settings | Members | Any | Read-only | The space's nominee limit per request (max_nominees) |
update_feedback_settings | Members | Admin | Changes | Changes the nominee limit per request (1 to 20; empty goes back to 5) |
create_feedback_theme | Members | Admin | Changes | Creates a theme, with an optional description |
update_feedback_theme | Members | Admin | Changes | Renames, describes, deactivates or reactivates a theme |
reorder_feedback_themes | Members | Admin | Changes | Changes the order of the themes |
create_feedback_behavior | Members | Admin | Changes | Adds a behavior to a theme |
update_feedback_behavior | Members | Admin | Changes | Renames, deactivates or reactivates a behavior |
reorder_feedback_behaviors | Members | Admin | Changes | Changes the order of a theme's behaviors |
list_development_plans | Members | Any | Read-only | The development plans you can see (scope: mine, team, to_approve, all), filtered by person and status |
get_development_plan | Members | Any (whoever sees the plan) | Read-only | One plan, with its actions, delays and what you can do with it |
list_development_plan_team | Members | Any (whoever leads) | Read-only | Your team: direct and indirect reports, with each one's status, progress and delays |
get_development_plan_dashboard | Members | Any (the management team: the space; a leader: their team) | Read-only | The dashboard per direct leader |
create_development_plan | Members | Any | Changes | Creates your plan, or a direct report's by name; dry_run shows who gets the e-mail |
update_development_plan | Members | Any (the person and whoever approves) | Changes | Changes title, period or actions; the person's change to an approved plan sends it back to approval |
delete_development_plan | Members | Any (the person and whoever approves) | Asks to confirm | Deletes a draft plan |
submit_development_plan | Members | Any (the person) | Changes | Sends your plan for approval |
approve_development_plan | Members | Any (the direct leader, the owner or the admin) | Changes | Approves a waiting plan |
return_development_plan | Members | Any (the direct leader, the owner or the admin) | Changes | Returns a plan with a required note |
complete_development_plan | Members | Any (the person and whoever approves) | Changes | Completes an approved plan |
create_development_plan_action | Members | Any (the person and whoever approves) | Changes | Adds an action, with a due date (due_on); course_id links a course |
update_development_plan_action | Members | Any (the person and whoever approves) | Changes | Changes an action or only its progress (status: TODO, IN_PROGRESS, DONE); course_id links a course |
delete_development_plan_action | Members | Any (the person and whoever approves) | Asks to confirm | Removes an action from the plan |
get_current_development_cycle | Members | Any | Read-only | The PDI cycle open for you, with the deadlines and where you stand |
list_development_cycles | Members | Admin or finance | Read-only | The space's PDI cycles, open and closed |
get_development_cycle | Members | Admin or finance | Read-only | One PDI cycle |
create_development_cycle | Members | Admin | Changes | Opens the PDI cycle: name, deadlines, audience and reminders; dry_run shows it first |
update_development_cycle | Members | Admin | Changes | Changes the cycle's name, deadlines, audience or reminders |
close_development_cycle | Members | Admin | Asks to confirm | Closes the cycle and stops the reminders; it doesn't reopen |
get_development_cycle_adhesion | Members | Any (the team: the audience; a leader: their team) | Read-only | Who sent, got approved or is late in the cycle, per leader |
get_time_clock | Members | Any | Read-only | The server time that counts for the punch, with the community's time zone |
get_time_tracking_space | Members | Any (whoever opens the space) | Read-only | The space as you see it: establishment, your employee record, whether you can clock in and whom to ask |
get_time_establishment_prefill | Members | Admin or finance | Read-only | Suggests the establishment from the community's company details |
list_time_establishments | Members | Admin or finance | Read-only | The community's establishments and each one's spaces |
get_time_establishment | Members | Admin or finance | Read-only | One establishment, with its spaces |
create_time_establishment | Members | Admin or finance | Changes | Registers the employer (CNPJ or CPF, CEI/CAEPF/CNO, legal name, workplace) |
update_time_establishment | Members | Admin or finance | Changes | Changes the employer's details; every change stays in the record |
export_time_afd | Members | Admin or finance | Read-only | Generates an establishment's AFD for a period, with the .sha256; 5-minute links |
set_time_tracking_space_establishment | Members | Admin or finance | Changes | Links the time tracking space to the establishment |
list_time_tracking_space_people | Members | Admin or finance | Read-only | Who opens the space and who doesn't have an employee record yet |
list_time_employees | Members | Admin or finance | Read-only | An establishment's employee records |
create_time_employee | Members | Admin or finance | Changes | Registers a person as an employee (CPF, hire date, job title) |
update_time_employee | Members | Admin or finance | Changes | Changes an employee record |
delete_time_employee | Members | Admin or finance | Asks to confirm | Ends a record; the punches already made are kept |
list_time_punches | Members | Any (the API decides) | Read-only | The punches (scope: mine, team, all), with NSR, hash, IP and location and the outside-the-radius badge (outsideRadius) |
get_time_punch | Members | Any (whoever sees the punch) | Read-only | One punch, with the receipt's details |
get_time_punch_receipt | Members | Any (whoever sees the punch) | Read-only | The punch receipt as a PDF, in a 5-minute link |
list_time_rules | Members | Admin or finance | Read-only | The space's rules: the defaults, the ones in effect and the versions |
create_time_rules | Members | Admin or finance | Changes | Saves a new version of the rules, for the space or a person's exception, with the start date |
list_time_holidays | Members | Any (whoever opens the space) | Read-only | The year's holidays: the national ones and the community's |
create_time_holiday | Members | Admin or finance | Changes | Adds a community holiday |
delete_time_holiday | Members | Admin or finance | Asks to confirm | Removes a holiday; a removed national holiday doesn't come back |
list_time_adjustments | Members | Any (the API decides) | Read-only | The adjustments (scope: mine, to_decide, team, all), filtered by status and month |
get_time_adjustment | Members | Any (whoever sees the adjustment) | Read-only | One adjustment, with the reason and the decision |
create_time_adjustment | Members | Any (the employee) | Changes | Requests an adjustment to your time record: include (add, with the time) or disregard (disregard, with the punch), with the reason |
decide_time_adjustment | Members | Any (the direct leader; without a leader, the management team) | Changes | Approves or rejects an adjustment (rejecting with a note); notifies the person by e-mail |
cancel_time_adjustment | Members | Any (whoever requested it) | Asks to confirm | Cancels your adjustment request that is still waiting |
get_timesheet | Members | Any (the person, the leaders and the management team) | Read-only | A person's monthly timesheet |
list_timesheets | Members | Any (the API decides) | Read-only | The month's totals per person (scope: team, all) |
list_timesheet_months | Members | Any (whoever opens the space) | Read-only | The closed and reopened months, with the history |
close_timesheet_month | Members | Admin or finance | Asks to confirm | Closes the month and freezes the totals; each employee gets an e-mail |
reopen_timesheet_month | Members | Admin | Asks to confirm | Reopens a closed month, with the reason |
acknowledge_timesheet_month | Members | Any (the employee) | Changes | Acknowledges your timesheet for a closed month |
export_timesheet_csv | Members | Admin or finance | Read-only | Exports the month as CSV, in a 5-minute link |
export_time_aej | Members | Admin or finance | Read-only | Generates an establishment's AEJ for a period, with the .sha256; 5-minute links |
set_time_tracking_geofence | Members | Admin | Changes | Sets the time tracking space's allowed radius: place, radius and mode (block or flag) |
remove_time_tracking_geofence | Members | Admin | Asks to confirm | Removes the allowed radius; no punch is refused or flagged |
list_time_geofence_refusals | Members | Admin or finance | Read-only | The punch attempts refused by the radius, with the distance |
get_my_chat_preferences | Members | Any | Read-only | Your chat preferences: your status (Available, Busy or Unavailable), show when I've read, whether you can start conversations and your unread messages |
update_my_chat_preferences | Members | Any | Changes | Changes your chat status (Available, Busy or Unavailable) and turns Read receipts on or off |
list_chat_online_members | Members | Any | Read-only | Who is available and online now, with each person's status (Available, Away or Busy; only for someone who is available too) |
list_chat_conversations | Members | Any | Read-only | Your conversations, with the last message and the unread count |
get_chat_conversation | Members | Any (only the two people) | Read-only | One of your conversations, with its messages, newest first |
contact_team | Members | Any | Changes | Opens the conversation with the team about a padlocked area, sending nothing |
send_chat_message | Members | Any | Asks to confirm | Sends a message in a conversation or to a person, opening the conversation if there is none |
mark_chat_conversation_read | Members | Any (only the two people) | Changes | Marks one of your conversations as read |
delete_chat_message | Members | Any (only the author) | Asks to confirm | Deletes one of your messages: it becomes "message deleted" for both |
clear_chat_history | Members | Any (only the two people) | Asks to confirm | Clears a conversation's history for you only: the messages so far disappear for you, the other person still sees everything; nothing is deleted |
list_chat_blocks | Members | Any | Read-only | The people you blocked |
block_chat_member | Members | Any | Changes | Blocks a person in the chat; nobody is told |
unblock_chat_member | Members | Any | Changes | Undoes your block; the conversation stays saved |
get_chat_settings | Members | Admin | Read-only | Whether the chat is on in the community and who can start conversations |
update_chat_settings | Members | Admin | Changes | Turns the chat on or off, chooses who can start and whether people must add each other first |
list_chat_members | Members | Any | Read-only | The People panel: who is available to chat, online first, with search by name (only for someone who is available too) |
list_chat_connections | Members | Any | Read-only | Your accepted connections in this community |
list_chat_connection_requests | Members | Any | Read-only | Pending connection requests, received (incoming) or sent (outgoing) |
request_chat_connection | Members | Any | Changes | Asks a person to connect; if they had already asked, the connection is accepted at once |
accept_chat_connection | Members | Any | Changes | Accepts a connection request you received |
decline_chat_connection | Members | Any | Changes | Declines a request you received, without telling the person who asked |
remove_chat_connection | Members | Any | Asks to confirm | Cancels your request or ends a connection |
send_member_notice | Members | Moderator | Changes | Bell notice to up to 100 people, no e-mail |
list_notifications | Members | Any | Read-only | Your notifications in this community (the bell), with unread and type filters |
get_notification | Members | Any | Read-only | One of your notifications |
mark_notifications_read | Members | Any | Changes | Marks one notification, or all, as read |
delete_notification | Members | Any | Asks to confirm | Removes a notification from your list; what it announced stays |
get_my_push_preferences | Members | Any | Read-only | Your browser and phone notification preferences |
update_my_push_preferences | Members | Any | Changes | Turns browser and phone notifications on or off by subject |
list_my_push_devices | Members | Any | Read-only | Your devices with notifications on |
remove_my_push_device | Members | Any | Asks to confirm | Removes one of your devices from notifications |
send_test_push | Members | Any | Changes | Sends a test notification to your devices |
pause_survey_recurrence | Members | Admin | Changes | Pauses the repeat: no new round opens, and the open one runs until it closes |
resume_survey_recurrence | Members | Admin | Changes | Resumes a paused repeat |
end_survey_recurrence | Members | Admin | Asks to confirm | Ends the repeat, for good; no round is deleted |
list_survey_rounds | Members | Admin | Read-only | The rounds, newest to oldest, with the response rate and the value of each NPS and scale question |
get_survey_evolution | Members | Admin | Read-only | The round-by-round evolution of each NPS and scale question, ready for a line chart |
get_survey_heatmap | Members | Admin | Read-only | The identified survey's heat map, by primary group, tag or company (dimension), for one round (round_id), with the change against the previous one |
export_survey_heatmap_csv | Members | Admin | Read-only | The heat map as CSV, the same file as the app |
create_review_cycle | Members | Admin | Changes | Creates a draft cycle: 90°, 180° or 360° model, period reviewed, answering window, audience and questions |
update_review_cycle | Members | Admin | Changes | Edits the cycle; once open, only title, instructions, closing date, reminders, rating rule and weights |
update_review_cycle_questions | Members | Admin | Changes | Replaces the draft's questions |
delete_review_cycle | Members | Admin | Asks to confirm | Deletes a draft cycle |
preview_review_cycle | Members | Admin | Read-only | What opening creates: participants, reviews per relationship and who has no manager |
open_review_cycle | Members | Admin | Asks to confirm | Opens the cycle and e-mails whoever has a review; refuses, with the names, while anyone has no manager |
close_review_cycle | Members | Admin | Asks to confirm | Closes the cycle and calculates the ratings, for good |
release_review_cycle_results | Members | Admin | Asks to confirm | Releases the results; first shows who gets the e-mail |
send_review_reminders | Members | Admin | Asks to confirm | Sends the reminder to whoever has a review pending; the first call shows who gets it |
add_review_assignment | Members | Admin | Changes | Adds a review to an open cycle |
cancel_review_assignments | Members | Admin | Asks to confirm | Cancels a person's reviews (takes them out of the cycle) |
list_review_cycles | Members | Any | Read-only | The cycles you can see, with the status |
get_review_cycle | Members | Any | Read-only | One cycle, with the dates, the model and the questions |
get_review_cycle_progress | Members | Any | Read-only | Progress per relationship and per person (the leader: their own team) |
list_review_cycle_assignments | Members | Admin | Read-only | Who reviews whom in the cycle, per person, with status and dates, never the answers |
list_review_cycle_results | Members | Any | Read-only | The results of the closed cycle (the leader: their own team) |
get_review_result | Members | Any | Read-only | One person's result in the cycle |
get_my_review_result | Members | Any | Read-only | Your result, after the release |
list_my_review_assignments | Members | Any | Read-only | The reviews you have to answer |
get_review_assignment | Members | Any | Read-only | One of your reviews, with the questions and the saved answers |
save_review_answers | Members | Any | Changes | Saves answers to one of your reviews, without sending |
submit_review_assignment | Members | Any | Changes | Sends one of your reviews; it can't be edited afterwards |
nominate_review_peers | Members | Any | Changes | Nominates the peers who will review you, within the cycle's minimum and maximum |
get_my_review_nominations | Members | Any | Read-only | Your nominations, with status and deadline |
list_review_nominations | Members | Any | Read-only | The nominations to validate (a leader: their direct team's; owner and admin: all) |
approve_review_nomination | Members | Any | Changes | Approves a nomination; the nominee gets the peer review |
replace_review_nomination | Members | Any | Changes | Swaps a nominee for another, already approved |
remove_review_nomination | Members | Any | Asks to confirm | Removes a nomination and cancels the peer review |
finalize_review_nominations | Members | Admin | Asks to confirm | Ends nominations now: approves the pending ones and fills in from the hierarchy |
get_review_calibration | Members | Admin | Read-only | The closed cycle's calibration: how many at each level and the adjustment history |
calibrate_review_result | Members | Admin | Changes | Adjusts a person's final level (and potential, with the 9-box), with a comment |
get_review_nine_box | Members | Any | Read-only | The cycle's 9-box: performance × potential, with the people in each box |
get_review_matrix | Members | Any | Read-only | The cycle's person × topic matrix, without comments |
export_review_results_csv | Members | Any | Read-only | The results as CSV, one row per person |
create_review_development_action | Members | Any | Changes | Brings a point of the released result into the Development Plan as an action |
create_goal_cycle | Members | Admin | Changes | Creates a goals cycle (title, period and check-in reminder) |
update_goal_cycle | Members | Admin | Changes | Edits the cycle |
close_goal_cycle | Members | Admin | Asks to confirm | Closes the cycle, for good: check-ins and reminders stop |
list_goal_cycles | Members | Any | Read-only | The goals cycles |
get_goal_cycle | Members | Any | Read-only | One cycle, with what you can create in it |
list_objectives | Members | Any | Read-only | The company → group → person tree, with a filter by group or owner |
get_objective | Members | Any | Read-only | One objective, with the KRs, the progress and the status light |
create_objective | Members | Any | Changes | Creates an objective with 1 to 20 KRs (parent_id aligns it) |
update_objective | Members | Any | Changes | Edits title, description, visibility and alignment |
delete_objective | Members | Any | Asks to confirm | Deletes the objective and its KRs |
create_key_result | Members | Any | Changes | Adds a KR: type (direction), unit, values, owner and weight |
update_key_result | Members | Any | Changes | Edits a KR |
delete_key_result | Members | Any | Asks to confirm | Removes a KR and its check-ins |
list_key_result_check_ins | Members | Any | Read-only | A KR's check-in history |
create_key_result_check_in | Members | Any | Changes | Records a check-in: current value (or delivered), status light and note |
list_my_key_results | Members | Any | Read-only | Your KRs in open cycles; pending_check_in shows only the ones without a check-in in the period |
get_review_assignment_objectives | Members | Any | Read-only | The goals of the period of whoever you review, in the self-review and in the manager's review |
list_one_on_ones | Members | Any | Read-only | Your series, with the next meeting |
get_one_on_one | Members | Any | Read-only | One series: next meetings, history and open agreements |
create_one_on_one | Members | Any | Changes | Starts a series with your direct leader or a direct report (the owner and the admin, between any direct pair) |
pause_one_on_one | Members | Any | Changes | Pauses the series |
resume_one_on_one | Members | Any | Changes | Resumes the series |
end_one_on_one | Members | Any | Asks to confirm | Ends the series, for good; the history stays |
get_one_on_one_meeting | Members | Any | Read-only | One meeting: agenda, notes and agreements |
reschedule_one_on_one_meeting | Members | Any | Changes | Reschedules only this meeting |
cancel_one_on_one_meeting | Members | Any | Asks to confirm | Cancels only this meeting |
complete_one_on_one_meeting | Members | Any | Changes | Marks the meeting as done; topics not discussed move to the next one |
add_one_on_one_topic | Members | Any | Changes | Adds a topic to the agenda |
reorder_one_on_one_topics | Members | Any | Changes | Reorders the agenda |
update_one_on_one_topic | Members | Any | Changes | Edits a topic or marks it as discussed |
delete_one_on_one_topic | Members | Any | Asks to confirm | Removes a topic from the agenda |
add_one_on_one_note | Members | Any | Changes | Writes a shared or private note |
update_one_on_one_note | Members | Any | Changes | Edits a note of yours |
delete_one_on_one_note | Members | Any | Asks to confirm | Deletes a note of yours |
create_one_on_one_action | Members | Any | Changes | Creates an agreement, with an owner and a due date |
update_one_on_one_action | Members | Any | Changes | Edits an agreement or marks it as done |
delete_one_on_one_action | Members | Any | Asks to confirm | Deletes an agreement |
send_one_on_one_action_to_pdi | Members | Any | Changes | Takes an agreement of the report to their Development Plan |
get_one_on_one_adherence | Members | Any (owner, admin and indirect leader) | Read-only | The adherence per leader: active and paused series, meetings done and canceled in 30 and 90 days |
log_one_on_one | Members | Any | Asks to confirm | Logs a 1:1 with your direct leader or a direct report: date (today or before, done; later, scheduled, with no invite), length, topics, shared note, private note and agreements. No e-mail: the other person gets the notice in the bell |
update_one_on_one_log | Members | Any (whoever logged it) | Changes | Changes the date, time or length of a 1:1 you logged |
delete_one_on_one_log | Members | Any (whoever logged it) | Asks to confirm | Deletes a 1:1 you logged; open agreements stay |
list_one_on_one_pairs | Members | Any (all: owner and admin) | Read-only | Your 1:1s by person: last, next and open agreements. With all, every pair in the community, read only |
get_one_on_one_dashboard | Members | Any | Read-only | The 1:1 space Manage dashboard: adherence, pairs and latest meetings |
list_my_subscription_charges | Subscriptions | Any | Read-only | The charges of your subscription |
quote_my_add_on | Subscriptions | Any, on their own subscription | Read-only | How much adding an add-on costs |
add_my_add_on | Subscriptions | Any, on their own subscription | Asks to confirm | Adds the add-on, by PIX or boleto |
pay_my_subscription_now | Subscriptions | Any, on their own subscription | Asks to confirm | Pays the overdue renewal, by PIX or boleto |
get_community_fees | Finance | Admin or finance | Read-only | The platform fee, minimum payout and methods |
get_email_stats | Community and structure | Admin | Read-only | The delivery numbers of the community's e-mails |
list_integrations | Community and structure | Any | Read-only | Your API keys (owner and admin: the whole community's, the webhooks and the ready-made integrations), without secrets |
get_email_notice_recipient_count | Community and structure | Moderator or finance | Read-only | How many people will get the e-mail notice of a publication |
get_classifieds_space_settings | Content and engagement | Any | Read-only | Allowed terms, whether the value shows, whether approval is required and the categories (with the ad count) of a space |
update_classifieds_space_settings | Content and engagement | Admin | Changes | Changes terms, value, approval and the complete category list |
list_classified_ads | Content and engagement | Any | Read-only | Lists the space's ads (category and text filters) or your own, in any status, with mine |
get_classified_ad | Content and engagement | Any | Read-only | One ad, with images, author and what you can do on it |
create_classified_ad | Content and engagement | Whoever can post in the space | Changes | Posts an ad, with images |
update_classified_ad | Content and engagement | Author | Changes | Edits your ad and adds or removes images |
delete_classified_ad | Content and engagement | Author, or team (owner, admin, moderator, finance) | Asks to confirm | Deletes an ad, with its images and interested people |
express_classified_interest | Content and engagement | Any (not the author) | Changes | Sends your interest, with a message |
list_classified_interests | Content and engagement | Author, or team | Read-only | Who is interested, with name, message and the account's email and phone |
update_classified_interest_status | Content and engagement | Author, or team | Changes | Marks an interest as seen or answered |
list_my_classified_interests | Content and engagement | Any | Read-only | The interests you sent |
withdraw_classified_interest | Content and engagement | Whoever sent it | Asks to confirm | Withdraws your interest in an ad |
get_channel_unread | Content and engagement | Any | Read-only | The unread state of each channel you open: messages, mentions and followed threads with new replies |
list_channel_messages | Content and engagement | Any | Read-only | The channel (whether you can post, react and moderate) and a page of up to 50 messages, with replies, reactions and media |
get_channel_thread | Content and engagement | Any | Read-only | A thread: the message and up to 50 replies |
list_channel_mentionable_members | Content and engagement | Any | Read-only | Who can be mentioned in the channel (from 3 letters), with the <@id> token to put in the text |
post_channel_message | Content and engagement | Whoever can post in the space | Asks to confirm | Sends a message to the channel; first shows the channel, how many people see it and the text |
reply_channel_thread | Content and engagement | Whoever can post in the space | Asks to confirm | Replies in a thread; first shows the channel, the message being answered and the text |
update_channel_message | Content and engagement | Author | Changes | Edits the text of your message or reply (it shows "(edited)") |
delete_channel_message | Content and engagement | Author, or owner, admin and moderator | Asks to confirm | Deletes a message or reply ("message deleted" stays; the thread goes on) |
set_channel_reaction | Content and engagement | Any | Changes | Adds or takes back your emoji reaction, even without permission to post |
follow_channel_thread | Content and engagement | Any | Changes | Follows a thread |
unfollow_channel_thread | Content and engagement | Any | Changes | Unfollows a thread |
mark_channel_read | Content and engagement | Any | Changes | Marks the channel as read, up to now or up to a message |
mark_channel_thread_read | Content and engagement | Any | Changes | Marks a thread as read |
mute_channel | Content and engagement | Any | Changes | Mutes a channel just for you: its mentions and replies stop generating notices and e-mails (unread messages keep counting) |
unmute_channel | Content and engagement | Any | Changes | Starts receiving the notices of a channel's mentions and replies again |
get_upvote_board | Content and engagement | Any | Read-only | The board: whether you can propose and manage, prior approval and the limits |
update_upvote_board | Content and engagement | Admin | Changes | Turns the board's prior approval on or off |
list_upvote_topics | Content and engagement | Any | Read-only | The topics, by most voted, newest or trending, with a state filter, yours and the ones you voted for |
get_upvote_topic | Content and engagement | Any | Read-only | A topic, with state, note, votes and comments |
find_similar_upvote_topics | Content and engagement | Any | Read-only | Up to 5 topics similar to a title, before creating |
create_upvote_topic | Content and engagement | Whoever can post in the space | Asks to confirm | Proposes a topic; first shows the board and the text |
update_upvote_topic | Content and engagement | Author (until someone else votes), or moderator | Changes | Edits the title or description |
delete_upvote_topic | Content and engagement | Author (until someone else votes), or moderator | Asks to confirm | Deletes a topic with its photos |
vote_upvote_topic | Content and engagement | Any | Changes | Votes on the topic, on your behalf |
unvote_upvote_topic | Content and engagement | Any | Changes | Takes your vote back |
create_upvote_comment | Content and engagement | Any | Changes | Comments or replies to a comment |
delete_upvote_comment | Content and engagement | Author, or moderator | Asks to confirm | Deletes a comment and its replies |
list_upvote_voters | Content and engagement | Moderator (not finance) | Read-only | Who voted, with the date they joined the community |
set_upvote_topic_status | Content and engagement | Moderator (not finance) | Asks to confirm | Changes the state (archiving included, with a reason); shows how many people will be notified |
reopen_upvote_topic | Content and engagement | Moderator (not finance) | Asks to confirm | Reopens a Done or Archived topic |
merge_upvote_topics | Content and engagement | Moderator (not finance) | Asks to confirm | Merges a repeated topic into the original, taking the votes along; can't be undone: the repeated one never reopens |
list_campaigns | Community and structure | Team (owner, admin, moderator, finance) | Read-only | Lists the campaigns, with the last send and the numbers; filters those sent in a period |
get_campaign | Community and structure | Team | Read-only | One campaign: subject, blocks, audience, status and the 10 latest sends, with totals for delivered, opens, clicks, bounces and complaints |
create_campaign | Community and structure | Team | Changes | Creates a draft (text, button and image blocks; audience); sends nothing |
update_campaign | Community and structure | Team | Changes | Edits a draft; blocks and audience replace the whole value |
preview_campaign_audience | Community and structure | Team | Read-only | Who would receive it: how many in the selection, how many the exclusion removed, how many are left out and why, and a sample with masked e-mails |
send_campaign_test | Community and structure | Team | Changes | Sends the campaign only to your own e-mail, with [Test] in the subject; does not use the quota (up to 10 per hour) |
send_campaign | Community and structure | Owner or admin | Asks to confirm | Sends now to the whole audience, with confirmation and consent |
get_campaign_quota | Community and structure | Team | Read-only | How many sends the community used and still has today, this week and this month, and when it resets |
delete_campaign | Community and structure | Team | Asks to confirm | Deletes a draft (a sent campaign stays in the history) |
list_campaign_opt_outs | Community and structure | Team | Read-only | Who unsubscribed, with masked e-mail, scope, date and source |
list_campaign_variables | Community and structure | Team | Read-only | The per-recipient campaign variables ({{nome}}, {{lider}}…), with name, description and example |
leave_course | Courses | Any | Changes | Leaves a course, keeping progress |
favorite_course | Courses | Any | Changes | Saves a course for later (or removes it from saved) |
schedule_campaign | Community and structure | Owner or admin | Asks to confirm | Schedules the send (once, every day or weekdays), with summary, quota and consent |
pause_campaign | Community and structure | Owner or admin | Changes | Pauses a scheduled or sending campaign |
resume_campaign | Community and structure | Owner or admin | Changes | Resumes a paused campaign |
cancel_campaign | Community and structure | Owner or admin | Asks to confirm | Cancels the campaign (what already went out stays sent) |
list_campaign_runs | Community and structure | Team | Read-only | A campaign's sends, with the numbers |
campaign_report | Community and structure | Team | Read-only | The sum of all sends: delivered, opens, clicks, bounces and complaints |
preview_campaign | Community and structure | Team | Read-only | The e-mail as it would go out now, without sending or using quota |
list_automatic_campaigns | Community and structure | Team | Read-only | The automatic e-mails and whether they are on |
update_automatic_campaign | Community and structure | Owner or admin | Asks to confirm | Turns an automatic on or off and adjusts it; always confirms, and requires consent when turning on |
upload_campaign_image | Community and structure | Team | Changes | Uploads an image for a block, by link or file |
delete_campaign_image | Community and structure | Team | Asks to confirm | Deletes an uploaded image (confirms) |
get_campaign_stats | Community and structure | Team | Read-only | The campaigns' numbers over a period, compared with the previous one |
list_campaign_block_items | Community and structure | Team | Read-only | The products, events or courses a block accepts |
duplicate_campaign | Community and structure | Team | Changes | Creates a draft copy of a campaign |
create_campaign_from_content | Community and structure | Team | Changes | Creates a campaign draft from a published post, with the audience of people who can access it; sends nothing |
list_emails | Community and structure | Team | Read-only | The library's e-mails, with their languages and where they are used |
get_email | Community and structure | Team | Read-only | An e-mail, with its versions per language |
create_email | Community and structure | Team | Changes | Creates an e-mail in the library |
update_email | Community and structure | Team | Changes | Renames the e-mail or changes the main language |
update_email_version | Community and structure | Team | Changes | Saves the version of a language |
delete_email_version | Community and structure | Team | Asks to confirm | Deletes the version of a language |
get_email_usages | Community and structure | Team | Read-only | Where the e-mail is used |
duplicate_email | Community and structure | Team | Changes | Copies the e-mail with all its versions |
delete_email | Community and structure | Team | Asks to confirm | Deletes the e-mail; shows first where it is used |
preview_email | Community and structure | Team | Read-only | Shows how the e-mail arrives, with your details |
send_email_test | Community and structure | Team | Changes | Sends a test only to you |
list_default_emails | Community and structure | Admin | Read-only | The default e-mails, with their state and customized languages |
get_default_email | Community and structure | Admin | Read-only | A default e-mail, with its fixed blocks and allowed variables |
get_default_email_version | Community and structure | Admin | Read-only | The community's version in a language |
update_default_email_version | Community and structure | Admin | Changes | Saves the community's version in a language |
update_default_email | Community and structure | Admin | Changes | Turns the community's version on or off |
restore_default_email | Community and structure | Admin | Asks to confirm | Restores the default in a language, with no way back |
preview_default_email | Community and structure | Admin | Read-only | Shows how the default e-mail arrives |
send_default_email_test | Community and structure | Admin | Changes | Sends a test of the default e-mail only to you |
list_workflow_triggers | Community and structure | Team | Read-only | The triggers, with the filters and the ones that act on an item |
list_workflows | Community and structure | Team | Read-only | The workflows, with the state and the runs |
get_workflow | Community and structure | Team | Read-only | One workflow, with the design |
simulate_workflow | Community and structure | Team | Read-only | Walks the workflow with one person, without sending anything |
get_workflow_estimate | Community and structure | Team | Read-only | How many people fired the trigger in 1, 7 and 30 days (or today, on a date trigger) |
list_workflow_runs | Community and structure | Team | Read-only | A workflow's runs |
get_workflow_run | Community and structure | Team | Read-only | One run, with the steps |
get_member_workflow_history | Community and structure | Team | Read-only | The workflows a person went through |
list_workflow_templates | Community and structure | Team | Read-only | The 9 templates |
list_workflow_senders | Community and structure | Team | Read-only | Who on the team agreed to sign messages |
update_my_workflow_sender_consent | Community and structure | Team | Changes | Agrees or stops agreeing to sign workflow messages (only your own) |
list_my_pending_sender_approvals | Community and structure | Team | Read-only | Your pending approvals of texts in your name |
approve_sender_approval | Community and structure | Team | Changes | Approves a version's texts in your name |
revoke_sender_approval | Community and structure | Team | Asks to confirm | Revokes an approval of yours |
create_workflow | Community and structure | Admin | Changes | Creates a draft workflow (trigger, filter, entry, frequency, design) |
create_workflow_from_template | Community and structure | Admin | Changes | Creates a draft from a template, without sending anything |
update_workflow | Community and structure | Admin | Changes | Edits the workflow; if it is on, saves a new version |
delete_workflow | Community and structure | Admin | Asks to confirm | Deletes a workflow that is off; the history stays |
send_workflow_test | Community and structure | Admin | Changes | Sends a step's e-mail only to you |
activate_workflow | Community and structure | Admin | Asks to confirm | Turns it on; first shows the trigger, the e-mails and the estimate (a date trigger asks for consent) |
pause_workflow | Community and structure | Admin | Changes | Pauses: nobody new enters and each person stops where they are |
resume_workflow | Community and structure | Admin | Asks to confirm | Resumes; first shows the summary |
cancel_workflow_run | Community and structure | Admin | Asks to confirm | Ends one person's run |
run_workflow | Community and structure | Admin | Asks to confirm | Starts the workflow for chosen people or an audience (Manual trigger); the first call only counts who enters and asks for your confirmation |
stop_workflow | Community and structure | Admin | Asks to confirm | Stops the workflow: no one new enters and the runs under way are canceled; first shows how many |
get_workflow_summary | Community and structure | Team | Read-only | The 7- and 30-day success rate, the skipped steps, the error logs, who is waiting for quota and the latest errors |
list_workflow_variables | Community and structure | Team | Read-only | The variables that reach a block, grouped by the block they come from (also for a design not saved yet) |
preview_workflow_text | Community and structure | Team | Read-only | A text with the variables filled with sample data, as it goes out in the DM, the e-mail or Slack |
get_workflow_settings | Community and structure | Admin | Read-only | On whose behalf workflows send DMs, comment and react |
update_workflow_settings | Community and structure | Admin | Asks to confirm | Switches to The whole team or Owner only; first shows the change |
get_workflow_webhook | Community and structure | Team | Read-only | The status of a Webhook received trigger's address, never the token |
create_workflow_webhook | Community and structure | Admin | Changes | Creates the address; the token and the secret are shown once |
rotate_workflow_webhook | Community and structure | Admin | Asks to confirm | Rotates the token and the secret |
revoke_workflow_webhook | Community and structure | Admin | Asks to confirm | Revokes the address |
list_workflow_webhook_deliveries | Community and structure | Team | Read-only | The calls received, with the result of each one |
get_workflow_guide | Community and structure | Team | Read-only | The workflow guide, one section at a time |
suggest_workflow | Community and structure | Team | Read-only | A rule in words becomes a workflow draft, without saving |
delete_workflow_run | Community and structure | Admin | Asks to confirm | Deletes a finished run from the history |
clear_workflow_runs | Community and structure | Admin | Asks to confirm | Deletes the finished runs from the history, all of them or up to a date |
list_env | Community and structure | Admin | Read-only | The vault keys, never the value |
set_env | Community and structure | Admin | Asks to confirm | Creates or replaces a vault key |
delete_env | Community and structure | Admin | Asks to confirm | Deletes a vault key |
get_ai_limits | Community and structure | Admin | Read-only | The AI blocks' token ceilings |
update_ai_limits | Community and structure | Admin | Changes | Changes the AI blocks' token ceilings |
get_signing_secret | Community and structure | Admin | Read-only | The Call webhook signing secret |
create_signing_secret | Community and structure | Admin | Changes | Generates the signing secret, shown only in this answer |
delete_signing_secret | Community and structure | Admin | Asks to confirm | Deletes the secret |
list_sending_reputation | Community and structure | SuperAdmin | Read-only | The communities on alert or suspended |
get_community_sending_reputation | Community and structure | SuperAdmin | Read-only | A community's sending reputation, with its suspensions |
lift_community_sending_suspension | Community and structure | SuperAdmin | Changes | Releases a community's sending, with the reason |
update_community_sending_reputation_settings | Community and structure | SuperAdmin | Changes | Changes a community's limits |
list_entitlement_catalog | Community and structure | Any | Read-only | The catalog of plan variables: included members, extra members, the mark and the Planning & HR and Coworking extensions |
get_plan_entitlements | Community and structure | Admin | Read-only | What the community's plan includes, where each value comes from (never the reason for an exception), member usage and locked extensions |
list_space_modules | Community and structure | Admin | Read-only | The space modules by Add Space tab, with locked when the extension is not in the plan |
get_entitlement_values | Community and structure | SuperAdmin | Read-only | What a Memberfy plan or add-on includes |
update_entitlement_values | Community and structure | SuperAdmin | Changes | Changes what a plan or add-on includes; applies to every community on it |
get_entitlement_defaults | Community and structure | SuperAdmin | Read-only | The default for communities without a plan |
update_entitlement_defaults | Community and structure | SuperAdmin | Changes | Changes the default for communities without a plan |
list_entitlement_overrides | Community and structure | SuperAdmin | Read-only | A community's exceptions, with value, reason and validity |
create_entitlement_override | Community and structure | SuperAdmin | Changes | Creates an exception (one per variable), with an internal reason and validity |
update_entitlement_override | Community and structure | SuperAdmin | Changes | Changes an exception's value, reason or validity |
delete_entitlement_override | Community and structure | SuperAdmin | Asks to confirm | Ends an exception now; the record is kept |
get_hub_listing | Community and structure | Admin | Read-only | How the community shows in the Memberfy directory, with a removal by Memberfy and the categories |
update_hub_listing | Community and structure | Admin | Changes | Turns the directory listing on or off and changes the category, cover and member count |
get_community_hub_listing | Community and structure | SuperAdmin | Read-only | One community's state in the Memberfy directory |
update_community_hub_listing | Community and structure | SuperAdmin | Changes | Takes a community out of the directory, with a reason, or puts it back |
get_custom_domain | Community and structure | Admin | Read-only | The Memberfy address, the primary one and the custom domain, with the DNS record to create and the step |
set_custom_domain | Community and structure | Admin | Changes | Adds or changes the custom domain, without downtime |
check_custom_domain | Community and structure | Admin | Changes | Checks the custom domain's DNS, certificate and address now |
remove_custom_domain | Community and structure | Admin | Asks to confirm | Removes the custom domain or gives up the one being set up |
get_community_custom_domain | Community and structure | SuperAdmin | Read-only | A community's custom domain |
set_community_custom_domain | Community and structure | SuperAdmin | Changes | Adds or changes a community's custom domain |
check_community_custom_domain | Community and structure | SuperAdmin | Changes | Checks a community's custom domain now |
remove_community_custom_domain | Community and structure | SuperAdmin | Asks to confirm | Removes a community's custom domain |
get_sms_settings | Community and structure | Admin | Read-only | The SMS channel, daily cap, quota and usage |
update_sms_settings | Community and structure | Admin | Changes | Turns SMS on or off and changes the daily cap |
send_sms_test | Community and structure | Admin | Asks to confirm | A test SMS to your phone |
count_sms_segments | Community and structure | Team | Read-only | The parts of an SMS text |
get_whatsapp_settings | Community and structure | Admin | Read-only | The WhatsApp channel, daily cap, quota and usage |
update_whatsapp_settings | Community and structure | Admin | Changes | Turns WhatsApp on or off and changes the daily cap |
list_whatsapp_templates | Community and structure | Admin | Read-only | WhatsApp's approved templates |
send_whatsapp_test | Community and structure | Admin | Asks to confirm | A test WhatsApp to your phone |
submit_quiz_attempt | Courses | Any | Changes | Submits a quiz's answers; if passed, completes the lesson |
list_quiz_attempts | Courses | Any | Read-only | Your last attempts at a quiz |
upload_lesson_media | Courses | Admin | Changes | Hosts a video or file in a lesson, by link or base64 |
upload_lesson_drop | Courses | Admin | Changes | Puts a recorded Drop as a lesson's video |
remove_lesson_media | Courses | Admin | Asks to confirm | Removes a lesson's hosted video or file |
get_lesson_media_url | Courses | Any | Read-only | Temporary link to watch or download |
remove_post_video | Content and engagement | Author, moderator or finance | Asks to confirm | Removes a post's video (hosted file or link) or a short post's Drop |
get_media_url | Content and engagement | Any | Read-only | 1-hour link to a hosted video or image |
reprocess_media | Content and engagement | Moderator or finance | Changes | Restarts a hosted video's conversion when it failed |
join_waitlist | Courses | Any | Changes | Joins the waitlist of a sold-out product |
leave_waitlist | Courses | Any | Changes | Leaves the waitlist |
my_waitlist_position | Courses | Any | Read-only | Your place in line |
list_waitlist | Courses | Moderator or finance | Read-only | Who is waiting, in order |
claim_free_product | Courses | Any | Changes | Gets a free product |
remove_event_recording | Events | Moderator or finance | Asks to confirm | Removes an event's hosted recording |
get_my_event_ticket | Events | Any | Read-only | Your ticket: QR, code and whether you checked in |
open_event_stream | Events | Any | Changes | Opens the live stream; signed in, it counts as attendance |
list_event_check_ins | Events | Team or organizer | Read-only | The door list, with filter and search |
check_in_event_attendee | Events | Team or organizer | Changes | Checks in by code, QR, ticket or member |
undo_event_check_in | Events | Team or organizer | Asks to confirm | Undoes a check-in; the registration stays |
export_event_check_ins | Events | Team or organizer | Read-only | The door list as CSV |
list_event_kiosks | Events | Team or organizer | Read-only | The event's kiosks |
grant_event_courtesy | Events | Admin | Changes | Grants a courtesy: confirmed and present, taking a seat |
create_event_kiosk | Events | Admin | Changes | Creates a kiosk link |
revoke_event_kiosk | Events | Admin | Asks to confirm | Revokes a kiosk at once |
preview_event_certificates | Events | Admin | Read-only | Who would get the automatic certificate and who is left out |
get_event_registration_questions | Events | Team or organizer | Read-only | The event's questions, with ids, type, required and Show at the door |
update_event_registration_questions | Events | Moderator or finance | Changes | Saves the whole set of questions (the Forms types plus the document); removing them all asks to confirm |
list_event_registrations | Events | Team or organizer | Read-only | Who registered, with their answers; filters by name or e-mail, by answer and by who still owes an answer |
export_event_registrations_csv | Events | Team or organizer | Read-only | The answers as CSV, with the whole document |
get_my_event_registration | Events | Any | Read-only | Your registration: the questions, what comes from your profile, your answers and until when you can edit |
update_my_event_registration | Events | Any | Changes | Changes your answers until the event starts; only what changes |
list_ticket_types | Events | Any | Read-only | An event's ticket types, with the current batch, the price and how many are left |
get_ticket_type | Events | Any | Read-only | A ticket type, with its batches |
quote_event_tickets | Events | Any | Read-only | Works out the price of a quantity of tickets of a type |
list_my_event_tickets | Events | Any | Read-only | Your tickets for an event, including the ones still to give |
assign_event_ticket | Events | Any | Changes | Gives a ticket from a group order to someone by e-mail; shows first who receives it (and whether a new account will be created) |
get_event_ticket_registration | Events | Any | Read-only | The registration answers of a ticket of yours |
update_event_ticket_registration | Events | Any | Changes | Answers the questions of a ticket of yours |
get_event_ticket_sales | Events | Admin or finance | Read-only | Sales per type and batch: tickets, orders, gross and refunded |
export_event_ticket_sales_csv | Events | Admin or finance | Read-only | The sales as CSV |
get_purchase_tickets | Events | Admin or finance | Read-only | An order's tickets, to choose the refund |
create_ticket_type | Events | Admin | Asks to confirm | Creates a ticket type with its first batch; when paid, asks to confirm |
update_ticket_type | Events | Admin | Changes | Edits a type (name, seats, minimum and maximum per order, shown on the page, proof, publish, close) |
delete_ticket_type | Events | Admin | Asks to confirm | Deletes a type without sales |
create_ticket_batch | Events | Admin | Asks to confirm | Adds a batch; when paid, asks to confirm |
update_ticket_batch | Events | Admin | Changes | Edits or closes a batch; changing the price asks to confirm |
delete_ticket_batch | Events | Admin | Asks to confirm | Deletes a batch without sales |
update_event_ticket_settings | Events | Admin | Changes | Event seats, show how many are left and the subscribers' type |
list_my_tickets | Events | Any | Read-only | Your tickets for every event: the upcoming ones, with the entry code and QR, or the past and canceled ones |
get_downloads_space_settings | Downloads | Anyone who sees the space | Read-only | A Downloads space's mode, approval and categories |
update_downloads_space_settings | Downloads | Admin | Changes | Changes the mode, the approval and the list of categories |
list_download_items | Downloads | Anyone who sees the space | Read-only | The space's items, with filters |
get_download_item | Downloads | Anyone who sees the space | Read-only | One item, with files and product |
create_download_item | Downloads | Whoever the space lets create | Changes | Creates an item (draft) with its product |
update_download_item | Downloads | Author or team | Changes | Edits the item, the stamp, the cover, and publishes |
delete_download_item | Downloads | Author or team | Asks to confirm | Deletes the item and its files |
upload_download_file | Downloads | Author or team | Changes | Uploads (or replaces) a file, by link or base64 |
remove_download_file | Downloads | Author or team | Asks to confirm | Removes a file |
reorder_download_files | Downloads | Author or team | Changes | Changes the order of the files |
get_download_url | Downloads | Anyone with access | Read-only | The 5-minute link for a file |
list_my_downloads | Downloads | Any | Read-only | What you can download |
get_download_stats | Downloads | Moderator or finance | Read-only | How many downloads each file had |
list_shows | Podcast and Videos | Any | Read-only | The shows in a space |
get_show | Podcast and Videos | Any | Read-only | One show, with its presenters |
create_show | Podcast and Videos | Admin | Changes | Creates a show, with cover and presenters |
update_show | Podcast and Videos | Admin | Changes | Edits the show |
delete_show | Podcast and Videos | Admin | Asks to confirm | Deletes the show and its episodes |
add_show_presenter | Podcast and Videos | Admin | Changes | Makes someone a presenter of the show |
remove_show_presenter | Podcast and Videos | Admin | Asks to confirm | Removes someone from the presenters |
get_show_stats | Podcast and Videos | Any | Read-only | The show's numbers, per episode (presenter or team) |
list_episodes | Podcast and Videos | Any | Read-only | A show's episodes |
get_episode | Podcast and Videos | Any | Read-only | One episode, by id or by link |
create_episode | Podcast and Videos | Any | Changes | Creates an episode (draft) with audio or video (presenter or admin) |
update_episode | Podcast and Videos | Any | Changes | Edits the episode, swaps the file and the chapters (presenter or admin) |
delete_episode | Podcast and Videos | Any | Asks to confirm | Deletes the episode (presenter or admin) |
publish_episode | Podcast and Videos | Any | Changes | Publishes now or schedules, with the e-mail's reach (presenter or admin) |
unpublish_episode | Podcast and Videos | Any | Asks to confirm | Sends the episode back to draft (presenter or admin) |
transcribe_episode | Podcast and Videos | Any | Changes | Asks for the transcript (presenter or admin) |
get_episode_transcript | Podcast and Videos | Any | Read-only | The transcript as text, cues or captions |
get_episode_stats | Podcast and Videos | Any | Read-only | An episode's numbers (presenter or team) |
save_episode_progress | Podcast and Videos | Any | Changes | Saves where you stopped |
react_to_episode | Podcast and Videos | Any | Changes | Reacts to the episode |
list_episode_comments | Podcast and Videos | Any | Read-only | The episode's comments |
create_episode_comment | Podcast and Videos | Any | Changes | Comments or replies, with an optional Drop |
update_episode_comment | Podcast and Videos | Any | Changes | Edits your comment |
delete_episode_comment | Podcast and Videos | Any | Asks to confirm | Deletes a comment and its replies |
react_to_episode_comment | Podcast and Videos | Any | Changes | Reacts to a comment |
get_my_media_queue | Podcast and Videos | Any | Read-only | Your queue |
queue_episode | Podcast and Videos | Any | Changes | Puts an episode at the end of the queue |
unqueue_episode | Podcast and Videos | Any | Changes | Removes an episode from the queue |
reorder_my_media_queue | Podcast and Videos | Any | Changes | Reorders the whole queue |
get_attendance_overview | Attendance | Anyone who sees the space | Read-only | The occupancy and your open visit |
check_in | Attendance | Any (yours); moderator or finance (someone else's) | Changes | Records an arrival, yours or a member's |
check_out | Attendance | Any (yours); moderator or finance (someone else's) | Changes | Records the departure |
list_present | Attendance | Moderator or finance | Read-only | Who's in the space now |
list_visits | Attendance | Moderator or finance (today); admin (any day) | Read-only | The visit history, with filters |
list_my_visits | Attendance | Any | Read-only | Your visits and the month's summary |
update_visit | Attendance | Moderator or finance (today); admin (any day) | Changes | Fixes a visit's arrival or departure |
delete_visit | Attendance | Admin | Asks to confirm | Removes a visit |
check_guest_in | Attendance | Moderator or finance | Changes | Records a guest's arrival |
list_attendance_kiosks | Attendance | Moderator or finance | Read-only | The space's kiosk devices |
create_attendance_kiosk | Attendance | Moderator | Changes | Generates a kiosk link (shown once) |
revoke_attendance_kiosk | Attendance | Moderator | Asks to confirm | Revokes a kiosk link |
get_parcels_overview | Parcels | Anyone who sees the space | Read-only | The space at a glance: the settings and how many are waiting |
get_parcel | Parcels | Any (yours); team (any) | Read-only | One parcel, with the photos |
do_i_have_parcels | Parcels | Any | Read-only | Your parcels, pending and history, with the place and the code |
mark_parcel_picked_up | Parcels | Any (yours); moderator or finance (others') | Changes | Marks the pickup |
search_parcel_recipients | Parcels | Moderator or finance | Read-only | Finds the recipient (person or company) by name |
register_parcel | Parcels | Moderator or finance | Changes | Registers the parcel and notifies the recipient by email |
list_pending_parcels | Parcels | Moderator or finance | Read-only | The queue of parcels waiting for pickup |
list_parcels | Parcels | Moderator or finance | Read-only | The history, with any status |
update_parcel | Parcels | Moderator or finance (waiting); admin (closed) | Changes | Fixes the data and the locker code |
add_parcel_photo | Parcels | Moderator or finance | Changes | Adds a photo |
replace_parcel_photo | Parcels | Moderator or finance | Changes | Replaces a photo |
return_parcel | Parcels | Moderator or finance | Changes | Returns to the sender |
remove_parcel_photo | Parcels | Moderator or finance | Asks to confirm | Removes a photo for good |
discard_parcel | Parcels | Admin | Changes | Discards a parcel nobody picked up |
reopen_parcel | Parcels | Admin | Changes | Undoes a closing |
delete_parcel | Parcels | Admin | Asks to confirm | Deletes a record made by mistake |
list_parcel_lockers | Parcels | Moderator or finance | Read-only | The space's lockers, in order, with the inactive ones |
create_parcel_locker | Parcels | Admin | Changes | Adds a locker |
update_parcel_locker | Parcels | Admin | Changes | Renames, reorders, activates or deactivates a locker |
delete_parcel_locker | Parcels | Admin | Asks to confirm | Removes a locker from the list |
search_booking_rooms | Bookings and Scheduling | Anyone who sees the space | Read-only | Finds what fits the request, with cost and balance |
check_availability | Bookings and Scheduling | Anyone who sees the space | Read-only | The free and taken times of a day |
list_booking_resources | Bookings and Scheduling | Anyone who sees the space | Read-only | The rooms, desks, stations and agendas |
list_booking_amenities | Bookings and Scheduling | Any | Read-only | The amenities catalog |
get_booking_resource | Bookings and Scheduling | Anyone who sees the space | Read-only | One room with the rules already resolved |
create_booking | Bookings and Scheduling | Any | Changes | Books for you and debits your credits |
create_booking_for_member | Bookings and Scheduling | Moderator (or finance) | Asks to confirm | Books for a member, debiting their credits |
list_my_bookings | Bookings and Scheduling | Any | Read-only | Your bookings (or the ones booked with you) |
list_bookings | Bookings and Scheduling | Moderator (or finance) | Read-only | All the community's bookings |
get_booking | Bookings and Scheduling | Booker, host and team | Read-only | One booking |
cancel_booking | Bookings and Scheduling | Booker, host and team | Asks to confirm | Cancels and refunds according to the rule |
reschedule_booking | Bookings and Scheduling | Booker, host and team | Asks to confirm | Changes the time and settles the credits |
mark_booking_no_show | Bookings and Scheduling | Team and host | Changes | Marks the no-show |
get_booking_ics | Bookings and Scheduling | Booker, host and team | Read-only | The calendar invite (.ics) |
create_booking_resource | Bookings and Scheduling | Admin (rooms) | Changes | Creates a room, desk or agenda |
update_booking_resource | Bookings and Scheduling | Admin (rooms) | Changes | Edits, replaces or removes the photo |
delete_booking_resource | Bookings and Scheduling | Admin | Asks to confirm | Deletes (canceling upcoming bookings) |
list_availability_exceptions | Bookings and Scheduling | Anyone who sees the space | Read-only | Blocks and extra hours |
create_availability_exception | Bookings and Scheduling | Team (rooms) | Changes | Blocks or opens a period |
cancel_bookings_for_closure | Bookings and Scheduling | Team (rooms) | Asks to confirm | Blocks, canceling the period's bookings |
delete_availability_exception | Bookings and Scheduling | Team (rooms) | Asks to confirm | Removes a block or extra hours |
list_price_rules | Bookings and Scheduling | Admin | Read-only | A room's price bands |
create_price_rule | Bookings and Scheduling | Admin | Changes | Creates a price band |
update_price_rule | Bookings and Scheduling | Admin | Changes | Edits a band |
delete_price_rule | Bookings and Scheduling | Admin | Asks to confirm | Removes a band |
list_room_panels | Bookings and Scheduling | Team | Read-only | The panels (tablet links) of a room |
create_room_panel | Bookings and Scheduling | Moderator | Changes | Creates a panel and shows the link only once |
revoke_room_panel | Bookings and Scheduling | Moderator | Asks to confirm | Revokes a panel's link |
check_in_booking | Bookings and Scheduling | Booking owner and moderator | Changes | Starts a booking's meeting |
get_scheduling_config | Bookings and Scheduling | Anyone who sees the space | Read-only | The Scheduling rules and your agendas |
search_scheduling_hosts | Bookings and Scheduling | Anyone who sees the space | Read-only | People with free time |
get_scheduling_host | Bookings and Scheduling | Anyone who sees the space | Read-only | A person's page, with the grid |
list_pending_scheduling_offers | Bookings and Scheduling | Admin | Read-only | Agendas waiting for approval |
set_booking_resource_listing | Bookings and Scheduling | Admin | Changes | Approves or takes an agenda off the list |
get_networking_settings | Networking | Anyone who sees the space | Read-only | The program options and your participation |
update_networking_settings | Networking | Admin | Changes | Changes the program options |
update_networking_badges | Networking | Admin | Changes | The first-session badges |
search_networking_profiles | Networking | Anyone who sees the space | Read-only | Searches people in Explore |
get_networking_profile | Networking | Anyone who sees the space | Read-only | A person's networking profile |
join_networking | Networking | Any | Changes | Asks to be a mentor (in a symmetric program, joins it) |
update_my_networking_profile | Networking | Any | Changes | Edits your profile, pauses and resumes |
leave_networking | Networking | Any | Asks to confirm | Leaves the program, canceling future sessions |
list_networking_requests | Networking | Admin | Read-only | The entry request queue |
decide_networking_request | Networking | Admin | Asks to confirm when rejecting | Approves or rejects a request |
list_networking_participants | Networking | Admin | Read-only | The people in the program |
add_networking_participant | Networking | Admin | Changes | Adds someone to the program |
update_networking_participant | Networking | Admin | Changes | Features, pauses, reactivates or changes the side |
remove_networking_participant | Networking | Admin | Asks to confirm | Removes someone, canceling future sessions |
book_networking_session | Networking | Any | Changes | Books a session |
list_networking_sessions | Networking | Any | Read-only | Your sessions: upcoming, past and to review |
get_networking_session | Networking | Both sides and the team | Read-only | One session |
accept_networking_session | Networking | The host | Changes | Accepts a session request |
decline_networking_session | Networking | The host | Asks to confirm | Declines a session request, with a reason |
review_networking_session | Networking | Both sides | Changes | Answers How did it go? |
list_networking_reviews | Networking | Anyone who sees the space | Read-only | A person's reviews |
update_networking_review | Networking | Moderator | Asks to confirm when hiding | Hides or shows a review |
list_networking_session_types | Networking | Anyone who sees the space | Read-only | A person's session types |
create_networking_session_type | Networking | The host | Changes | Creates a session type |
update_networking_session_type | Networking | The host | Changes | Edits a session type |
delete_networking_session_type | Networking | The host | Asks to confirm | Removes a session type |
get_credit_balance | Credits | Any (yours); team (someone else's) | Read-only | The balance, what expires in 7 days and the batches |
list_credit_entries | Credits | Any (yours); team (someone else's) | Read-only | The statement, newest first |
get_company_credit_balance | Credits | Any (the API checks who reads) | Read-only | The wallet balance of a company |
list_company_credit_entries | Credits | Any (the API checks who reads) | Read-only | The company wallet statement, with who used it |
grant_credits | Credits | Finance | Asks to confirm | Opens a new batch of credits, with a reason |
adjust_credits | Credits | Finance | Asks to confirm | Adds credits as a correction, with a reason |
revoke_credits | Credits | Finance | Asks to confirm | Takes credits back (negative adjustment) |
get_credit_settings | Credits | Moderator (or finance) | Read-only | The community's credit rules |
update_credit_settings | Credits | Admin | Changes | Changes the rules |
create_visitor_invitation | Visitors | Any with access to the space (the settings can restrict); team, on behalf of another host | Changes | Registers a guest |
list_visitor_invitations | Visitors | Any (a member sees their own) | Read-only | Lists and searches guests |
get_visitor_invitation | Visitors | Owner of the registration or team | Read-only | One registration |
update_visitor_invitation | Visitors | Owner of the registration or team | Changes | Edits before the arrival |
cancel_visitor_invitation | Visitors | Owner of the registration or team | Asks to confirm | Cancels a registration |
list_visitors_today | Visitors | Moderator or finance | Read-only | Today's expected and arrived guests |
search_visitor_hosts | Visitors | Moderator or finance | Read-only | Finds the host |
mark_visitor_arrived | Visitors | Moderator or finance | Changes | Marks the arrival |
undo_visitor_arrival | Visitors | Moderator or finance | Changes | Undoes an arrival |
list_companies | Companies | Moderator or finance | Read-only | The companies, with type, status and team size |
get_company | Companies | Moderator or finance | Read-only | One company |
get_my_company | Companies | Any | Read-only | The company you are on, with the team and what you get through it |
create_company | Companies | Admin | Changes | Registers a company, with the optional coworking block |
update_company | Companies | Admin | Changes | Edits the name and the coworking block |
close_company | Companies | Admin | Asks to confirm | Closes the company, with or without the team |
list_company_members | Companies | Any (the API checks the link) | Read-only | A company's team |
invite_company_member | Companies | Any (the API checks the link) | Changes | Adds someone to the team by e-mail |
update_company_member | Companies | Admin | Changes | Marks or unmarks the company admin |
remove_company_member | Companies | Any (the API checks the link) | Asks to confirm | Takes someone off the team |
list_company_invitations | Companies | Any (the API checks the link) | Read-only | The pending invitations the company admin sent |
list_my_company_invitations | Companies | Any | Read-only | Your company invitations |
accept_company_invitation | Companies | Any (their own invitation) | Changes | Accepts your invitation and joins the team |
decline_company_invitation | Companies | Any (their own invitation) | Asks to confirm | Declines your invitation, for good |
get_support_space_settings | Support | Any | Read-only | How the space works: limits, deadlines and, for the team, who answers |
get_support_overview | Support | Moderator or finance | Read-only | The queue in numbers |
list_support_tickets | Support | Moderator or finance | Read-only | The whole queue, with filters and deadlines |
list_my_support_tickets | Support | Any | Read-only | Your tickets |
get_support_ticket | Support | Any (the resident reads their own) | Read-only | One ticket with the conversation and the photos |
get_support_resource_open_count | Support | Any | Read-only | How many open tickets an item has |
create_support_ticket | Support | Any | Changes | Opens a ticket, with photos |
update_support_ticket | Support | Moderator or finance, and answering the category | Changes | Triage: status, priority, category, assignee, place |
add_support_comment | Support | Any (the note, only whoever answers) | Changes | Comments, or writes an internal note |
cancel_support_ticket | Support | Any (the resident, their own) | Asks to confirm | Cancels a ticket |
reopen_support_ticket | Support | Any (the resident, their own resolved one) | Changes | Reopens a ticket |
add_support_photo | Support | Any | Changes | Attaches a photo |
replace_support_photo | Support | Any | Changes | Swaps one photo for another |
remove_support_photo | Support | Any | Asks to confirm | Removes a photo |
delete_support_comment | Support | Admin | Asks to confirm | Deletes a message from the conversation |
delete_support_ticket | Support | Admin | Asks to confirm | Deletes a ticket and its photos |
close_resource_for_ticket | Support | Admin | Asks to confirm | Takes the ticket's room out of use for a period |
reopen_resource_for_ticket | Support | Admin | Changes | Puts the room back in use |
get_support_report | Support | Moderator or finance | Read-only | The Support report for a period |
list_inspection_sectors | Support | Moderator or finance | Read-only | The round sectors, with their spots |
create_inspection_sector | Support | Admin | Changes | Creates a round sector |
update_inspection_sector | Support | Admin | Changes | Renames or reorders a sector |
delete_inspection_sector | Support | Admin | Asks to confirm | Removes a sector and its spots |
create_inspection_spot | Support | Admin | Changes | Adds a spot to a sector |
update_inspection_spot | Support | Admin | Changes | Edits a spot |
delete_inspection_spot | Support | Admin | Asks to confirm | Removes a spot |
list_inspection_rounds | Support | Moderator or finance | Read-only | The round history |
get_inspection_round | Support | Moderator or finance | Read-only | One round, spot by spot |
start_inspection_round | Support | Moderator (not finance) | Changes | Starts or resumes a sector round |
mark_inspection_spot | Support | Moderator (not finance) | Changes | Marks a spot OK or problem (a problem opens a ticket) |
complete_inspection_round | Support | Moderator (not finance) | Changes | Completes the round |
get_support_resource_history | Support | Moderator or finance | Read-only | The maintenance history of a room |
get_email_provider | Community and structure | Admin | Read-only | Whether e-mails leave through the community's Resend account, the status and the sender |
update_email_provider | Community and structure | Admin | Changes | Changes the sender of the Resend account |
verify_email_provider | Community and structure | Admin | Changes | Sends the Resend account's verification e-mail |
disconnect_email_provider | Community and structure | Admin | Asks to confirm | Disconnects the Resend account; everything leaves through Memberfy again |
list_video_keys | Community and structure | Admin | Read-only | The Bunny and Cloudflare signing keys, without the value |
update_video_key | Community and structure | Admin | Changes | Saves or replaces a video provider's signing key |
verify_video_key | Community and structure | Admin | Changes | Checks the key with one of the provider's videos |
delete_video_key | Community and structure | Admin | Asks to confirm | Deletes a video provider's signing key |
list_scheduled_posts | Content and engagement | Any | Read-only | The scheduled posts: the team sees all, everyone else their own |
publish_scheduled_post | Content and engagement | Any | Changes | Publishes a scheduled post now |
get_member_points | Content and engagement | Admin | Read-only | A member's points balance and statement |
get_points_settings | Content and engagement | Admin | Read-only | Points as currency: on, name, start and circulation |
update_points_settings | Content and engagement | Admin | Changes | Turns points on as currency and names it |
get_welcome_settings | Members | Admin | Read-only | The welcome, the missions and each one's numbers |
update_welcome_settings | Members | Admin | Asks to confirm | Changes the screens, the mode and the missions, with confirmation |
get_my_referral | Members | Any | Read-only | Your referral link and how many joined through it |
get_referral_report | Members | Moderator (not finance) | Read-only | Who brought whom, with the totals |
get_referral_settings | Members | Admin | Read-only | Whether referrals are on |
update_referral_settings | Members | Admin | Changes | Turns referrals on or off |
redeem_product_with_points | Sales and plans | Any | Asks to confirm | Spends your points balance on a product priced in points |
How many each role sees
| Role | Tools |
|---|---|
| Owner and admin | All 866 |
| Moderator | 564: update_avatar, list_integrations (their own API keys), the 40 call-for-papers tools, the read tools open to everyone, posts and short posts (including moving and pinning), comments, reactions and gallery, moderation, create_event, update_event and live streaming, list_members and the 10 for groups, tags and the org chart, certificate templates, issuing, resending and retrying (per Who issues in the space), their own enrollments, attendance, points, subscriptions, purchases and certificates, and the member, engagement (with the statement, list_engagement_activities), event and course reports and community_overview. Plus the Classifieds ones: posting, showing interest and, for the team, seeing the interested people and moderating. Plus, depending on the role, the e-mail campaign tools (team) and the ones for leaving and saving courses. Plus the Downloads tools the space allows, the waitlist and free-product tools (including list_waitlist), the hosted media tools (get_media_url, remove_post_video, remove_event_recording, reprocess_media) and the download counters. Plus the company tools the role reaches. Plus the inspection round tools the role reaches. Plus the 16 development plan tools and get_recognition_card. Plus the 15 Time Tracking tools open to everyone (the API decides). Plus get_my_team and the 11 Messages tools open to everyone. Plus the 16 Forms tools open to everyone (the API decides who manages each form). Plus the 4 for video covers and Drop text, open to everyone. Plus the 7 event check-in tools open to everyone (the route decides) and list_entitlement_catalog and set_video_cover_frame. Plus the 29 for Channel and Upvote (the API decides who posts, moderates and changes the state) and the 4 for logging and looking up 1:1s. Plus, for the team, the workflow read tools, the ones for signing messages and the e-mail library ones; and, for everyone, the ticket type tools the role reaches (view, quote, your tickets and giving a ticket). Plus muting and unmuting a channel and your tickets for every event. Plus count_sms_segments and the 5 for your own SMS and WhatsApp notices (see and change the notices, your consents and verifying your phone). Plus get_post_metrics, open to everyone (the API only shows the numbers of their own posts). |
| Finance | 601: update_avatar, list_integrations (their own API keys), the 40 call-for-papers tools, the read tools open to everyone, posts, comments, reactions and gallery, reading plans, products and coupons, the 13 finance read tools (including abandoned carts) and refunds (refund_purchase), the community's subscriptions (list, view, export, complimentary, actions and cancel), their own subscriptions (with add-on and Pay now), purchases, points and certificates, the sales and subscription reports, the purchase funnel (analytics_report), the financial Logs (list_logs) and community_overview. Plus the Classifieds ones: posting, showing interest and, for the team, seeing the interested people and moderating. Plus, depending on the role, the e-mail campaign tools (team) and the ones for leaving and saving courses. Because finance is part of the team, it also has everything the moderator has: moderation of every type, events, members, groups and tags, certificates and the community reports. Plus the Downloads tools the space allows, the waitlist and free-product tools (including list_waitlist), the hosted media tools (get_media_url, remove_post_video, remove_event_recording, reprocess_media) and the download counters. Plus the company tools the role reaches. Plus the inspection round tools the role reaches. Plus the 18 development plan tools and get_recognition_card. Plus 35 Time Tracking tools: the 15 open to everyone and the 20 for the time tracking management (all but reopening a month and setting or removing the radius). Plus get_my_team and the 11 Messages tools open to everyone. Plus the 16 Forms tools open to everyone (the API decides who manages each form). Plus the 4 for video covers and Drop text, open to everyone. Plus the 7 event check-in tools open to everyone (the route decides) and list_entitlement_catalog and set_video_cover_frame. Plus the 29 for Channel and Upvote (the API decides who posts, moderates and changes the state) and the 4 for logging and looking up 1:1s. Plus, for the team, the workflow read tools, the ones for signing messages and the e-mail library ones; and, for everyone, the ticket type tools the role reaches (view, quote, your tickets and giving a ticket). Plus muting and unmuting a channel and your tickets for every event. Plus count_sms_segments and the 5 for your own SMS and WhatsApp notices (see and change the notices, your consents and verifying your phone). Plus get_post_metrics, open to everyone (the API only shows the numbers of their own posts). |
| Member | 411: update_avatar, list_integrations (their own API keys), the 40 call-for-papers tools, the read tools open to everyone, posts and short posts, comments, reactions and gallery (editing and deleting only their own), enrollment and progress in courses, event attendance, and their own subscriptions (with add-on and Pay now), purchases, points and certificates. Plus the Classifieds ones: posting, showing interest and, for the team, seeing the interested people and moderating. Plus, depending on the role, the e-mail campaign tools (team) and the ones for leaving and saving courses. Plus the Downloads tools the space allows, the waitlist and free-product tools, and the hosted media link (get_media_url). Plus the company tools the role reaches. Plus the 16 development plan tools and get_recognition_card. Plus the 15 Time Tracking tools open to everyone (the API decides). Plus get_my_team and the 11 Messages tools open to everyone. Plus the 16 Forms tools open to everyone (the API decides who manages each form). Plus the 4 for video covers and Drop text, open to everyone. Plus the 7 event check-in tools open to everyone (the route decides) and list_entitlement_catalog and set_video_cover_frame. Plus the 29 for Channel and Upvote (the API decides who posts, moderates and changes the state) and the 4 for logging and looking up 1:1s. Plus the ticket type tools the role reaches (view, quote, your tickets and giving a ticket). Plus muting and unmuting a channel and your tickets for every event. Plus the 5 for your own SMS and WhatsApp notices (see and change the notices, your consents and verifying your phone). Plus get_post_metrics, open to everyone (the API only shows the numbers of their own posts). |
All 40 call-for-papers tools show up for everyone because a call's owner can be a regular member, and any member proposes, reviews or votes when the call allows it. Memberfy checks each call against the module's rules. See Call for papers.
A connection authorized for reading only sees just the role's read tools.
Seeing a tool in the list doesn't guarantee every call goes through: Memberfy checks each action as if it were done on screen. A member sees create_post, but posting in a space with Who can post = Staff is refused. See Roles and permissions.
Shared rules
Ids
The tools work with ids, and wherever they ask for an id they also accept the link copied from the app (see open_link). Almost every conversation starts with get_community_context, which returns the sections and spaces with their ids; the list tools return the ids of what they list. Each tool's description says where each id comes from, and the assistant chains them on its own: you ask "post in the Announcements space", it looks up the Announcements space id and posts.
Pagination
List tools accept page (the page, starting at 1) and limit (how many per page). The response includes the items and the total, so the assistant knows whether to ask for the next page.
Draft first
Everything that is sold starts as a draft: create_product, the product from create_course, the ticket from create_event and the options from create_plan. So does the event: create_event creates the draft and publishes it at the end (with as_draft: true, it stops at the draft, which only the team sees), and publish_event publishes it later. Nothing goes on sale without publish_product (or publish: true in the composite tool). That way you review first.
Creating doesn't depend on approved business information; publishing does. In a community without approval, a composite tool that was asked to publish undoes nothing: the course, event or plan stays as a draft, the response gives the reason in publish_blocked, and the suggested next step is to fill in the business information and publish later. See Drafts before approval.
Idempotency in the composite tools
The three composite tools accept idempotency_key (up to 100 characters). Repeating the call with the same key returns the result of the first one, without creating anything again. It's for when the connection drops mid-call and the assistant doesn't know whether the call went through.
Undoing when a step fails
The composite tools create things in order and, if a step fails, delete what they had already created (except when what failed was publishing without approved business information: then everything stays as a draft), newest first, and say which step failed: "The step "módulo 2" failed and everything this call created was undone." If something can't be undone, the response lists what was left behind so you can check it in the dashboard.
Next steps
When a follow-up makes sense, the tool's response carries next_steps: up to three suggested actions, each with the tool, the reason (in the language of whoever connected) and, sometimes, the arguments ready to use. They depend on what came back and on your role: only tools you can use are included. The assistant offers these actions before suggesting anything else, and none of them happens unless you ask.
| When | What Memberfy suggests |
|---|---|
| There are proposals waiting for a decision | Decide each one (decide_proposal) |
| The engagement report shows posts with no reply | Reply to them (create_comment) |
| A post was published without a cover | Generate an image and set it as the cover (update_post) |
| A certificate template was just created | Check the preview and adjust it (update_certificate_template), then activate it (activate_certificate_template) |
| A sales report | The same report for the previous period, to compare (sales_report, with the dates filled in) |
| Items waiting for moderation | Approve or reject them (moderate_item) |
| Past-due subscriptions | Send the payment link (update_subscription) |
| Available balance | Request a payout (request_payout) |
| A product, course or ticket created as a draft | Publish it (publish_product) |
| Publishing was refused for lack of approved business information | Fill in Settings › Business information, wait for approval and publish (publish_product) |
| A call for papers created without tracks, or still a draft | Add tracks (add_call_track), add reviewers (invite_track_reviewer) and publish (update_call_status) |
| An accepted proposal | Confirm it in the program (confirm_proposal) |
Errors
When Memberfy refuses, the assistant gets Memberfy's message, the same one you'd see on screen:
| Situation | What the assistant gets |
|---|---|
| The role doesn't allow it | "Your role (moderator) does not allow this action in this community.", plus the reason |
| An invalid value | "The API refused (400): …", with the field and the message |
| Too many calls | "Too many calls in a short time. Wait a minute and try again." |
| Memberfy has suspended the community | The error with code: COMMUNITY_SUSPENDED (and, for the team, the reason) on invites, imports and sales. See Suspension of joining and sales |
Server and tool list version
Every Memberfy deploy changes the server version, and the tool list a connection receives has its own fingerprint. That's how you tell whether an assistant's list is up to date.
| Where | What comes back |
|---|---|
serverInfo.version, in initialize | <version>+<commit>, for example 1.0.0+4a9b547. Changes on every deploy |
_meta.memberfy, in initialize and tools/list | server_version, tools_fingerprint (a short code that changes when a name or input schema in this connection's list changes) and tool_count |
| The server instructions | End with a line that repeats the list version |
Calling a tool that isn't on the connection's list returns a tool error (isError) asking the person to open a new conversation or reconnect; if the name is one of the old Portuguese ones, the response includes renamed_to with the new name. The call is logged in the audit as tool.unknown.
The owner and admins compare the last list a connection received with the current one at GET /api/oauth/connections/{id}/diagnostics: the listUpToDate field says whether it's up to date. See Audit.
Ask for confirmation
Only the tools that touch money and the ones that delete (those starting with delete_, remove_, revoke_, withdraw_ or cancel_) ask for confirmation. With the Asks to confirm badge, they don't act on the first call: they return a summary and a code, and only act when the assistant repeats the call with the code, after your yes. All the others, including invites, role changes, settings and issuing certificates, run on the first call. The table above shows each one's badge. See Money and confirmation.
Markdown text
The assistant writes and reads Memberfy text in Markdown. Memberfy converts it to the app's formatted text on the way in, and back to Markdown on the way out: the post shows in the app with bold and lists, not with asterisks.
| Field | What it takes |
|---|---|
The text of a post (create_post, update_post), an event's description (create_event, update_event), the call for papers text (create_call_for_papers, update_call_for_papers) and a proposal's description (submit_proposal, update_proposal) | Full Markdown: bold, italic, lists, links, subheadings (# becomes a level-2 subheading; there is no level-1 heading inside the text), quote and code |
The text of a short post (create_short_post, or update_post with type: status) | Only bold, italic, links and line breaks |
| Titles, names, comments, and the description of a course, product, plan, group, space and section | Plain text: Markdown marks are stripped, because the app shows these fields without formatting |
What doesn't carry over to the app:
- An image inside the text becomes a link to the image. For a post's cover or an event's banner, use
image_url(see Images). - A table becomes lines of text, one per table row.
- Scripts, event attributes and
javascript:links are removed.
Ready-made HTML is accepted too and goes through the same filter. When reading, the tools return formatted text in Markdown and mark the result with text_format: "markdown". Reading and saving the same text again changes nothing.
Images
create_post, add_gallery_image, add_gallery_images, create_course, create_event, update_post, update_event and update_course accept the image in two ways:
image_url: the link to an image that is on the internet. Memberfy downloads it and keeps it as if you had uploaded it in the dashboard.image_base64(withimage_type, optional): the file itself, up to 5 MB. It's the way to use an image the assistant generated in the conversation. SVG is accepted and becomes PNG; an SVG that points to external files is refused.
| Rule | |
|---|---|
| Address | Only public http or https. Internal and private addresses are refused, also after a redirect |
| Format | JPEG, PNG, WebP or GIF, checked from the file's content |
| Size | Up to 50 MB |
| Time | The download has 20 seconds |
A link to a page (rather than to the image itself) is refused with "the file is not a JPEG, PNG, WebP or GIF image".
In the composite tools, a bad image doesn't undo the rest: the course or event is created without the cover, and the response gives the reason in warnings ("Could not use the image at …: the image is larger than 50 MB."). Ask again with another link, or add the image in the dashboard. In the single-item tools (create_post, add_gallery_image), a bad image prevents the creation. In add_gallery_images, a bad image fails on its own and the others go in.
Profile picture and featured image. update_avatar sets or removes a profile picture (your own, your account's or, for a moderator, someone else's), and create_event, update_event, create_call_for_papers and update_call_for_papers accept the square featured image (1:1) by link or file, besides the banner. The formats are JPEG, PNG, WebP and GIF, and a file can be up to 5 MB; SVG becomes PNG. The assistant doesn't save the community banner: change it in the dashboard.