> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Kapso

> Kapso provides APIs for WhatsApp messaging, customer and contact management, broadcasts, workflows, and serverless functions.

![Kapso logo](https://mintcdn.com/composio-preview/tIuAovF9-7pXq2wA/images/toolkits/kapso.svg?fit=max\&auto=format\&n=tIuAovF9-7pXq2wA\&q=85\&s=97c8578c8edeb24d81c721695854389e)

* **Category:** communication
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 12
* **Triggers:** 0
* **Slug:** `KAPSO`
* **Version:** 20261101\_00

## Tools

> [accordion] Get Contact
>
> **Slug:** `KAPSO_GET_CONTACT`
>
> Retrieve one Kapso WhatsApp contact by UUID, phone number, business-scoped user ID, or parent business-scoped user ID. A parent business-scoped user ID can match multiple contacts; Kapso returns the most recently created one.
>
> #### Input Parameters
>
> **identifier** `string` *required*
>
> Contact UUID, WhatsApp phone number, business-scoped user ID, or parent business-scoped user ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Function
>
> **Slug:** `KAPSO_GET_FUNCTION`
>
> Retrieve one Kapso serverless function's code, runtime configuration, deployment status, and computed URLs without invoking or changing it.
>
> #### Input Parameters
>
> **function\_id** `string` *required*
>
> Function UUID returned by KAPSO\_LIST\_FUNCTIONS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Phone Number
>
> **Slug:** `KAPSO_GET_PHONE_NUMBER`
>
> Retrieve one Kapso WhatsApp phone-number configuration by its Meta phone number ID.
>
> #### Input Parameters
>
> **phone\_number\_id** `string` *required*
>
> Meta phone number ID returned by KAPSO\_LIST\_PHONE\_NUMBERS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Phone Number Health
>
> **Slug:** `KAPSO_GET_PHONE_NUMBER_HEALTH`
>
> Run Kapso's live checks for one WhatsApp phone-number configuration and return its body-level health status and individual check results.
>
> #### Input Parameters
>
> **phone\_number\_id** `string` *required*
>
> Meta phone number ID returned by KAPSO\_LIST\_PHONE\_NUMBERS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Workflow
>
> **Slug:** `KAPSO_GET_WORKFLOW`
>
> Retrieve one workflow's metadata, full graph definition, or available variables without executing or changing it.
>
> #### Input Parameters
>
> **view** `string ("metadata" | "definition" | "variables")`
>
> Choose metadata and execution stats, the complete nodes and edges graph, or fixed and discovered variables.
>
> **workflow\_id** `string` *required*
>
> Workflow UUID returned by KAPSO\_LIST\_WORKFLOWS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Conversations
>
> **Slug:** `KAPSO_LIST_CONVERSATIONS`
>
> List one page of WhatsApp conversations by recent activity, with filters for phone number, status, assignment, and activity time range.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum conversations to return on this page (1-100).
>
> **status** `string ("active" | "ended")`
>
> Filter by active or ended conversation status.
>
> **unassigned** `boolean`
>
> Set true to return only unassigned conversations; cannot be combined with assigned\_user\_id.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page and pass it back unchanged.
>
> **phone\_number\_id** `string`
>
> Filter by Meta phone number ID.
>
> **assigned\_user\_id** `string`
>
> Filter by active assignee project-user UUID.
>
> **last\_active\_after** `string`
>
> Return conversations active after this ISO 8601 timestamp.
>
> **last\_active\_before** `string`
>
> Return conversations active before this ISO 8601 timestamp.
>
> **contact\_phone\_number** `string`
>
> Filter by a partial contact phone number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Customers
>
> **Slug:** `KAPSO_LIST_CUSTOMERS`
>
> List Kapso project customers and filter them by name, external customer ID, or creation time. Returns one page and a continuation cursor.
>
> #### Input Parameters
>
> **per\_page** `integer`
>
> Maximum customers to return on this page (minimum 1).
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> **created\_after** `string`
>
> Return customers created at or after this ISO 8601 timestamp.
>
> **name\_contains** `string`
>
> Filter by a customer-name substring.
>
> **created\_before** `string`
>
> Return customers created at or before this ISO 8601 timestamp.
>
> **external\_customer\_id** `string`
>
> Filter by the caller-defined external customer ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Functions
>
> **Slug:** `KAPSO_LIST_FUNCTIONS`
>
> List serverless functions configured in the Kapso project, including runtime and deployment state, without returning function source code or invoking any function.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Messages
>
> **Slug:** `KAPSO_LIST_MESSAGES`
>
> List one page of WhatsApp message history project-wide through Kapso Platform or for one phone number through the Meta-compatible proxy. This tool only reads history and never sends messages.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum messages to return on this page (1-100).
>
> **status** `string ("pending" | "sent" | "delivered" | "read" | "failed")`
>
> Filter by message delivery status.
>
> **direction** `string ("inbound" | "outbound")`
>
> Filter by inbound or outbound direction.
>
> **api\_surface** `string ("platform" | "meta_proxy")`
>
> Use platform for project-wide history or meta\_proxy for one phone number's Meta-compatible history.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged; its original surface and filters are restored automatically.
>
> **conversation\_id** `string`
>
> Filter messages by conversation ID.
>
> **phone\_number\_id** `string`
>
> Filter Platform results by Meta phone number ID. Required for api\_surface='meta\_proxy', where it identifies the path resource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Phone Numbers
>
> **Slug:** `KAPSO_LIST_PHONE_NUMBERS`
>
> List WhatsApp phone-number configurations in the Kapso project, with filters for account, customer, messaging state, and display name.
>
> #### Input Parameters
>
> **per\_page** `integer`
>
> Maximum phone-number configurations to return on this page (minimum 1).
>
> **customer\_id** `string`
>
> Filter by Kapso customer UUID.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> **name\_contains** `string`
>
> Filter by a case-insensitive display-name substring.
>
> **phone\_number\_id** `string`
>
> Return only the configuration with this Meta phone number ID.
>
> **messaging\_enabled** `boolean`
>
> Filter by whether messaging is enabled.
>
> **business\_account\_id** `string`
>
> Filter by WhatsApp Business Account ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Workflows
>
> **Slug:** `KAPSO_LIST_WORKFLOWS`
>
> List project workflows and filter them by lifecycle status, name, or creation time. This read-only action does not execute a workflow.
>
> #### Input Parameters
>
> **status** `string ("draft" | "active" | "archived")`
>
> Filter by workflow lifecycle status.
>
> **created\_after** `string`
>
> Return workflows created at or after this ISO 8601 timestamp.
>
> **name\_contains** `string`
>
> Filter by a case-insensitive workflow-name substring.
>
> **created\_before** `string`
>
> Return workflows created at or before this ISO 8601 timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Contact
>
> **Slug:** `KAPSO_UPDATE_CONTACT`
>
> Update a Kapso WhatsApp contact's phone-number identity, profile, customer association, or metadata. A parent business-scoped user ID can match multiple contacts; Kapso updates the most recently created one.
>
> #### Input Parameters
>
> **wa\_id** `string`
>
> Replacement WhatsApp phone-number identity in E.164 format.
>
> **metadata** `object`
>
> Replacement custom key-value metadata. Supply an empty object to clear it.
>
> **identifier** `string` *required*
>
> Contact UUID, WhatsApp phone number, business-scoped user ID, or parent business-scoped user ID.
>
> **customer\_id** `string`
>
> Replacement Kapso customer UUID to associate with the contact.
>
> **display\_name** `string`
>
> Replacement application-defined display name.
>
> **profile\_name** `string`
>
> Replacement name shown on the contact's WhatsApp profile.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
