/

Back to MB Suite

Menu

API reference

Organization

48 operations

Context

GET/v1/meWho am I, where am I, what can I do GET/v1/catalogThe operations this caller can run

Organizations

GET/v1/orgsList the organizations this caller can reach GET/v1/orgs/{target_org_id}Get one reachable organization

Trash

GET/v1/trashList items in the trash POST/v1/trash/{item_id}/restoreRestore an item from the trash DELETE/v1/trash/{item_id}Permanently remove an item from the trash

Jobs

GET/v1/jobs/{job_id}Get a background job and its result GET/v1/jobsList background jobs

Access request

POST/v1/phones/access-requestsAsk MB Suite to enable Phones

Modules

GET/v1/modulesList the organization's modules and which are on POST/v1/modules/{module_id}/toggle-freeTurn a free module on or off

Tracking pixel

GET/v1/trackingGet the attribution pixel and its health POST/v1/tracking/enableTurn on the attribution pixel POST/v1/tracking/disableTurn off the attribution pixel POST/v1/tracking/rotate-idReplace the pixel's public id POST/v1/tracking/verifyCheck that the pixel is installed on a page POST/v1/tracking/send-instructionsEmail the pixel's install instructions PATCH/v1/tracking/allowed-domainsSet the sites the pixel accepts

AI agents

GET/v1/ai/agentsList the organization's AI agents GET/v1/ai/agents/{agent_id}Get one AI agent with its configuration POST/v1/ai/agentsCreate an AI agent POST/v1/ai/agents/with-keyCreate an AI agent with a key that has the createAiAgents permission PATCH/v1/ai/agents/{agent_id}Update an AI agent PATCH/v1/ai/agents/{agent_id}/liveUpdate an AI agent, also one working live, with a key allowed to DELETE/v1/ai/agents/{agent_id}Delete an AI agent GET/v1/ai/system-agentsList MB Suite's system AI agents

AI usage

GET/v1/ai/usageGet the organization's AI usage and credit balance for a month GET/v1/ai/usage/monthsList the months with AI usage

Agent work

GET/v1/ai/work/routinesList the organization's routines GET/v1/ai/work/routines/{task_id}Get one routine GET/v1/ai/work/routine-templatesList the routine templates POST/v1/ai/work/routinesSet up a routine PATCH/v1/ai/work/routines/{task_id}Change a routine POST/v1/ai/work/routines/{task_id}/pausePause a routine POST/v1/ai/work/routines/{task_id}/resumeResume a routine POST/v1/ai/work/routines/{task_id}/take-overTake over a routine DELETE/v1/ai/work/routines/{task_id}Delete a routine POST/v1/ai/work/routines/{task_id}/runRun a routine now GET/v1/ai/work/proposalsList the routines' proposals POST/v1/ai/work/proposals/{proposal_id}/decideApprove or reject a routine's proposal GET/v1/ai/work/deliverablesList what the routines left GET/v1/ai/work/deliverables/{deliverable_id}Get one deliverable DELETE/v1/ai/work/deliverables/{deliverable_id}Delete a deliverable GET/v1/ai/work/settingsGet the routines' limits PATCH/v1/ai/work/settingsChange the routines' limits POST/v1/ai/work/errandsHand an errand to an agent POST/v1/ai/work/errands/{run_id}/cancelCancel an errand