Reference
What Mello can do API
5 operations. Generated from the OpenAPI document, so this page always matches the API.
OpenAPI documentErrors and rate limitsSDK and CLI recipes
On this page
capabilities.requests
How many people asked HR to connect a system, per capability
POST/api/v1/manage/capabilities/requests
- Read
- Permission capabilities.requests
const result = await shuffl.capabilities.requests();Request fields (none)
This operation takes no input.
Response object
- requests object[] required
- capabilityId "badges" | "celebrations" | "celebrations_program" | "communities" | "connected_docs" | "connections_program" | "groups" | "hr_inbox" | "hr_request" | "insights" | "intros" | "knowledge" | "knowledge_tools" | "manager_plans" | "mentorship" | "mentorship_programs" | "my_reports" | "notifications" | "onboarding" | "people" | "people_admin" | "people_sync" | "playbook_auto_start" | "playbooks" | "policies" | "praise" | "praise_program" | "profile" | "pulse" | "pulse_mine" | "time_off_balance" | "time_off_request" | "what_mello_can_do" | "who_knows" | "workspace" required
- latest string required
- need null | string required
- people number required
- title string required
capabilities.sheet
What Mello can answer and do for you here, and what connecting a system would add
POST/api/v1/manage/capabilities/sheet
- Read
- Permission capabilities.sheet
const result = await shuffl.capabilities.sheet();Request fields (none)
This operation takes no input.
Response object
- admin boolean required
- rows object[] required
- audience "everyone" | "hr" | "manager" required
- connection null | "knowledge_tool" | "people_sync" | "time_off" required
- id "badges" | "celebrations" | "celebrations_program" | "communities" | "connected_docs" | "connections_program" | "groups" | "hr_inbox" | "hr_request" | "insights" | "intros" | "knowledge" | "knowledge_tools" | "manager_plans" | "mentorship" | "mentorship_programs" | "my_reports" | "notifications" | "onboarding" | "people" | "people_admin" | "people_sync" | "playbook_auto_start" | "playbooks" | "policies" | "praise" | "praise_program" | "profile" | "pulse" | "pulse_mine" | "time_off_balance" | "time_off_request" | "what_mello_can_do" | "who_knows" | "workspace" required
- kind "ask" | "do" required
- need null | string required
- result string required
- say string required
- since null | string required
- status "available" | "coming" | "needs_connection" | "needs_setup" required
- system string required
- title string required
capabilities.unlocks
What people can ask and do once an HR system or document tool is connected
POST/api/v1/manage/capabilities/unlocks
- Read
- Permission capabilities.unlocks
const result = await shuffl.capabilities.unlocks({
"kind": "directory",
"provider": "<provider>"
});Request fields (2)
- kind "directory" | "knowledge" required
- provider string required
Response object
- rows object[] required
- coming boolean required
- id "badges" | "celebrations" | "celebrations_program" | "communities" | "connected_docs" | "connections_program" | "groups" | "hr_inbox" | "hr_request" | "insights" | "intros" | "knowledge" | "knowledge_tools" | "manager_plans" | "mentorship" | "mentorship_programs" | "my_reports" | "notifications" | "onboarding" | "people" | "people_admin" | "people_sync" | "playbook_auto_start" | "playbooks" | "policies" | "praise" | "praise_program" | "profile" | "pulse" | "pulse_mine" | "time_off_balance" | "time_off_request" | "what_mello_can_do" | "who_knows" | "workspace" required
- kind "ask" | "do" required
- say string required
- title string required
capabilities.dismissRequests
Clear the asks to connect a system for one capability
POST/api/v1/manage/capabilities/dismissRequests
- Write
- Permission capabilities.dismissRequests
- Needs a requestKey
- Needs confirm set to capabilities.dismissRequests
const result = await shuffl.capabilities.dismissRequests({
"capabilityId": "badges",
"confirm": "capabilities.dismissRequests",
"requestKey": "a-new-unique-key"
});Request fields (3)
- capabilityId "badges" | "celebrations" | "celebrations_program" | "communities" | "connected_docs" | "connections_program" | "groups" | "hr_inbox" | "hr_request" | "insights" | "intros" | "knowledge" | "knowledge_tools" | "manager_plans" | "mentorship" | "mentorship_programs" | "my_reports" | "notifications" | "onboarding" | "people" | "people_admin" | "people_sync" | "playbook_auto_start" | "playbooks" | "policies" | "praise" | "praise_program" | "profile" | "pulse" | "pulse_mine" | "time_off_balance" | "time_off_request" | "what_mello_can_do" | "who_knows" | "workspace" required
- confirm "capabilities.dismissRequests" required
- requestKey string required1 to 128 characters
Response object
- receipt object required
- completedAt string (date-time) | null required
- createdAt string (date-time) required
- id string (uuid) required
- operation string required
- requestKey string required
- status "running" | "succeeded" | "failed" | "unknown" required
- result object | null required
- dismissed number required
capabilities.requestConnection
Ask HR to connect the system this needs
POST/api/v1/manage/capabilities/requestConnection
- Write
- Permission capabilities.requestConnection
- Needs a requestKey
- Needs confirm set to capabilities.requestConnection
const result = await shuffl.capabilities.requestConnection({
"capabilityId": "badges",
"confirm": "capabilities.requestConnection",
"requestKey": "a-new-unique-key"
});Request fields (3)
- capabilityId "badges" | "celebrations" | "celebrations_program" | "communities" | "connected_docs" | "connections_program" | "groups" | "hr_inbox" | "hr_request" | "insights" | "intros" | "knowledge" | "knowledge_tools" | "manager_plans" | "mentorship" | "mentorship_programs" | "my_reports" | "notifications" | "onboarding" | "people" | "people_admin" | "people_sync" | "playbook_auto_start" | "playbooks" | "policies" | "praise" | "praise_program" | "profile" | "pulse" | "pulse_mine" | "time_off_balance" | "time_off_request" | "what_mello_can_do" | "who_knows" | "workspace" required
- confirm "capabilities.requestConnection" required
- requestKey string required1 to 128 characters
Response object
- receipt object required
- completedAt string (date-time) | null required
- createdAt string (date-time) required
- id string (uuid) required
- operation string required
- requestKey string required
- status "running" | "succeeded" | "failed" | "unknown" required
- result object | null required
- alreadyAsked boolean required
- requested boolean required