API REFERENCE

List Connector Actions

On this page

GET/api/connectors/actions

List the executable actions available across the authenticated account's connectors. Each action is a single tool that can be invoked via POST /api/connectors/actions — for example, the googlesheets connector exposes actions like GOOGLESHEETS_WRITE_SPREADSHEET. Actions whose parent connector is not yet connected are returned with isConnected: false and cannot be executed until the connector is authorized via POST /api/connectors.

Authentication

x-api-key in header

bearerAuth bearer

Request

cURL

curl --request GET \
  --url 'https://api.recoupable.dev/api/connectors/actions' \
  --header 'x-api-key: YOUR_API_KEY'

Replace the YOUR_ placeholders with your values. Required query parameters are included; optional parameters are listed below.

Parameters

Query parameters

account_idstring

Optional account ID to list actions for a different account (e.g., an artist or organization). The authenticated account must have access. Omit to list actions for your own account.

Responses

200Actions retrieved successfully

application/json

successbooleanrequired

actionsarray<ConnectorAction>required

Available actions across all connectors the authenticated account has access to. Both connected and unconnected actions are returned — check isConnected per action before attempting execution.

Item properties

slugstringrequired

Unique identifier for the action — pass this as actionSlug when calling POST /api/connectors/actions. Action slugs are always UPPERCASE_SNAKE_CASE (e.g. GITHUB_CREATE_ISSUE, GMAIL_FETCH_EMAILS, GOOGLESHEETS_WRITE_SPREADSHEET).

namestringrequired

Human-readable action name.

descriptionstringrequired

What the action does. Use this to pick the right action from the catalog.

parametersobjectrequired

JSON Schema describing the parameters this action expects. Pass values matching this schema in the parameters field of the execute request.

connectorSlugstringrequired

Slug of the parent connector this action belongs to (e.g. 'googlesheets', 'tiktok', 'youtube', 'twitter', 'linkedin'). Matches the slug returned by GET /api/connectors.

isConnectedbooleanrequired

Whether the parent connector is currently authorized for this account. Actions can only be executed when this is true.

400Bad request — invalid account_id format

application/json

errorintegerrequired

format: int32

messagestringrequired

401Unauthorized — invalid or missing API key

application/json

errorintegerrequired

format: int32

messagestringrequired

403Forbidden — no access to the specified account

application/json

errorintegerrequired

format: int32

messagestringrequired

Full specification

Download the OpenAPI file for complete schemas, constraints, and examples.

Download social.json

View operation source

json

{
  "security": [
    {
      "apiKeyAuth": []
    },
    {
      "bearerAuth": []
    }
  ],
  "description": "List the executable actions available across the authenticated account's connectors. Each action is a single tool that can be invoked via POST /api/connectors/actions — for example, the `googlesheets` connector exposes actions like `GOOGLESHEETS_WRITE_SPREADSHEET`. Actions whose parent connector is not yet connected are returned with `isConnected: false` and cannot be executed until the connector is authorized via POST /api/connectors.",
  "parameters": [
    {
      "name": "account_id",
      "in": "query",
      "description": "Optional account ID to list actions for a different account (e.g., an artist or organization). The authenticated account must have access. Omit to list actions for your own account.",
      "required": false,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Actions retrieved successfully",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ConnectorActionsResponse"
          }
        }
      }
    },
    "400": {
      "description": "Bad request — invalid account_id format",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized — invalid or missing API key",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "403": {
      "description": "Forbidden — no access to the specified account",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}