Welcome to Recerc Docs Admin Use Cases MCP: Use Recerc with Claude & Codex Customer Portal Getting Started Security at Recerc Webhooks Getting Started

Delete activity DELETE Create or update an activity POST List activities by object POST

Delete agent DELETE Get agent GET Create agent POST List agents POST Update agent PUT

Preview analytics query POST Run workspace query POST

Get active cart GET List session carts GET Update cart comment PATCH Rename cart PATCH Create cart POST Select active cart POST Submit active cart POST Update cart line item PUT

Get public catalog GET Get current viewer access GET List viewer delivery addresses GET Request restricted catalog access POST Verify catalog user POST

List catalogs GET Get catalog products GET Get current catalog GET Get catalog settings GET Approve access request POST Reject access request POST Query catalog carts POST Create catalog user POST Delete catalog user POST Query catalog users POST Update catalog PUT Set catalog user state PUT

Delete chat context DELETE List chat contexts GET Get chat context GET Get chat conversation GET Create chat context POST List chat history POST Update chat context PUT

Delete custom view DELETE List custom views GET Get custom view GET Save custom view PUT

Delete a customer DELETE Get a customer GET Get recent customers GET Search customers GET Update a single customer value PATCH Create a customer POST Query customers POST Update a customer PUT

List export jobs GET List export targets GET Create an export job POST

Get favorite status by ids POST Toggle favorite state POST Set favorite state PUT

List files GET List order files GET Associate file POST Confirm upload POST Create upload URL POST

Get home stats GET Send feedback POST

Get product media import job status GET Create product media import job POST Import products POST

List inbox conversations GET Get inbox conversation GET List inbox threads GET Get inbox thread GET Create inbox thread POST Run inbox agent POST Create inbox message POST

Delete WhatsApp integration DELETE Get Kapso customer GET List WhatsApp integrations GET Ensure Kapso customer POST Handle WhatsApp failure callback POST Handle WhatsApp success callback POST Create WhatsApp inbox link POST Create WhatsApp integration POST Sync WhatsApp integrations POST Create WhatsApp setup link POST

Linked Email Accounts

List linked email accounts GET Get linked email account GET Disconnect linked email account POST Reconnect linked email account POST Revoke linked email account POST Send linked email POST

Delete a custom object record by handle and id DELETE Delete a view DELETE Get recent objects by handle GET Search objects by handle GET Get an object record by handle and id GET List custom object definitions GET Get an object definition by handle GET Get an optional object definition by handle GET List native object definitions GET List views GET Get default object view config GET Get a view by id GET Update a custom object record by handle and id PATCH Resolve objects by ids POST Import object data POST Suggest object import mappings POST Create a custom object definition POST Query object records POST Create a custom object record POST Create many custom object records POST Create a view POST Update an object definition PUT Save default object view config PUT Update a view PUT

Delete order DELETE Get order by id GET Get order item columns GET List order events GET Get snapshot URL GET Update order PATCH Update order field PATCH Create order POST Resolve order customer filter options POST Search order customer filter options POST Import an order from files or text POST Convert quote to sales order POST Duplicate order POST Send a quote by email POST Query orders POST List order templates POST

Delete person DELETE Get person by id GET Update person field value PATCH Create person POST Query people POST Update person PUT

Delete price list DELETE Delete product price item DELETE Get price lists GET Get price list events GET Get price items for list GET Get product price items GET Import price data POST Create or update price list POST Process uploaded price list file POST Set product price item PUT

Delete product list DELETE Create or update product list POST Query product lists POST

Product Recommendations

Get product recommendations POST

Delete product category DELETE Delete product DELETE Remove product document DELETE Remove product file association DELETE List product categories GET List products by category GET List product category taxonomies GET Get product filter options GET Search product filter options GET Get product by id GET Set product category PATCH Set product document technical specifications flag PATCH Create product POST Get products by ids POST Create product category POST Create product category taxonomy POST Create product collection POST Add product to collection POST Activate product POST Archive product POST Add product document POST Add product file association POST Query products POST Search products POST Reindex workspace product search POST Reindex workspace products in Turbopuffer POST Update product category PUT Update product category taxonomy PUT Update product PUT

Delete report DELETE List reports GET Get report by handle GET Create report POST Invalidate report view cache POST Run report view POST Update report PUT

Remove order requirement template DELETE Get global default-agent memory GET Get personal default-agent memory GET Get global agent prompt GET Get company settings GET Get customer table settings GET Get order requirements settings GET Get transcription memory GET List my workspaces GET Get current workspace GET Get default workspace taxes GET Get workspace quick access GET Toggle order requirements PATCH Toggle order requirement template PATCH Add order requirement template POST Create workspace POST Accept workspace invitation POST Save global default-agent memory PUT Save personal default-agent memory PUT Save global agent prompt PUT Save company settings PUT Save order requirements settings PUT Save transcription memory PUT

Health check GET

Delete task DELETE Get task by id GET Update task PATCH Create task POST Bulk delete tasks POST Query tasks POST

Delete template DELETE Create template POST Load my default template POST Save default template POST List templates POST Resolve effective default template POST Update template PUT

Soft delete a workspace user DELETE Get current feature flags GET Get Current Preference GET Get a workspace user GET List available workspace roles GET Search workspace users GET Set a current feature flag PATCH Update a workspace user PATCH Invite a workspace user POST Query workspace users POST Set Current Preference PUT Update workspace user roles PUT

Ingest a webhook event POST

List workflows GET Get workflow by id GET

Settings

Workspace settings, selection, defaults, and configuration endpoints served through Effect HttpApi.

Available Methods

Each method has its own page with request and response details, examples, and generated code snippets.

GET
/api/configs/agent-memory/global
Get global default-agent memory
PUT
/api/configs/agent-memory/global
Save global default-agent memory
GET
/api/configs/agent-memory/personal
Get personal default-agent memory
PUT
/api/configs/agent-memory/personal
Save personal default-agent memory
GET
/api/configs/agent-prompt
Get global agent prompt
PUT
/api/configs/agent-prompt
Save global agent prompt
GET
/api/configs/company
Get company settings
PUT
/api/configs/company
Save company settings
GET
/api/configs/customers-table
Get customer table settings
GET
/api/configs/order-requirements
Get order requirements settings
PUT
/api/configs/order-requirements
Save order requirements settings
PATCH
/api/configs/order-requirements/enabled
Toggle order requirements
POST
/api/configs/order-requirements/templates
Add order requirement template
DELETE
/api/configs/order-requirements/templates/{templateId}
Remove order requirement template
PATCH
/api/configs/order-requirements/templates/{templateId}/enabled
Toggle order requirement template
GET
/api/configs/transcription-memory
Get transcription memory
PUT
/api/configs/transcription-memory
Save transcription memory
GET
/api/workspaces
List my workspaces
POST
/api/workspaces
Create workspace
POST
/api/workspaces/{workspaceId}/accept-invitation
Accept workspace invitation
GET
/api/workspaces/current
Get current workspace
GET
/api/workspaces/default-taxes
Get default workspace taxes
GET
/api/workspaces/quick-access
Get workspace quick access

Update report PUT

Updates a custom report owned by the current workspace user.

Remove order requirement template DELETE

Deletes the order requirement template identified by templateId.