Constructors

Properties

Methods

Constructors

Properties

client: Composio

Methods

  • Connects an account to the Composio platform.

    This method allows you to connect an external app account with Composio. It requires the integration ID in the request body and returns the connection status, connection ID, and a redirect URL (if applicable) for completing the connection flow.

    Parameters

    Returns CancelablePromise<CreateConnectionResponse>

    A promise that resolves to the connection status and details.

    Throws

    If the request fails.

  • Retrieves details of a specific account connected to the Composio platform by providing its connected account ID.

    The response includes the integration ID, connection parameters (such as scope, base URL, client ID, token type, access token, etc.), connection ID, status, and creation/update timestamps.

    Parameters

    Returns CancelablePromise<GetConnectedAccountResponse>

    A promise that resolves to the details of the connected account.

    Throws

    If the request fails.

  • Initiates a new connected account on the Composio platform.

    This method allows you to start the process of connecting an external app account with Composio. It requires the integration ID and optionally the entity ID, additional parameters, and a redirect URL.

    Parameters

    • data: undefined | {
          data?: {
              [key: string]: unknown;
          };
          integrationId: string;
          redirectUri?: string;
          userUuid?: string;
      }

      The data for the request.

    Returns Promise<ConnectionRequest>

    A promise that resolves to the connection request model.

    Throws

    If the request fails.

  • Retrieves a list of all connected accounts in the Composio platform.

    It supports pagination and filtering based on various parameters such as app ID, integration ID, and connected account ID. The response includes an array of connection objects, each containing details like the connector ID, connection parameters, status, creation/update timestamps, and associated app information.

    Parameters

    Returns CancelablePromise<ListAllConnectionsResponse>

    A promise that resolves to the list of all connected accounts.

    Throws

    If the request fails.