> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List a project's channels

> List a project's channels.

`veryfront__list_channels`

Requires project.channels.read.

## Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

**Call type:** Read-only.

## Arguments

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `project_reference` | `string` | No | Project ID or slug |

## Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See [MCP client setup](/docs/cloud/getting-started/connect-mcp.md).

```json title="request.json" theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__list_channels",
    "arguments": {}
  }
}
```

## Result

The published output shape is summarized below. Inspect both the MCP response content and `isError` when handling a call.

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `data` | `object[]` | Yes | All project channels, newest first by creation time then ID. This complete list is not paginated. |

## Full schemas

```json title="input-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Arguments for the list_channels tool."
}
```

```json title="output-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Unique identifier for the returned record."
          },
          "project_id": {
            "type": "string",
            "format": "uuid",
            "description": "Project identifier associated with this result."
          },
          "binding_id": {
            "type": "string",
            "format": "uuid",
            "description": "The binding id returned by the tool."
          },
          "installation_id": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid",
                "description": "The installation id returned by the tool."
              },
              {
                "type": "null",
                "description": "The installation id returned by the tool."
              }
            ],
            "description": "The installation id returned by the tool."
          },
          "platform": {
            "type": "string",
            "enum": [
              "slack"
            ],
            "description": "The platform returned by the tool."
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "description": "Human-readable name for the returned record."
          },
          "agent_id": {
            "anyOf": [
              {
                "type": "string",
                "minLength": 1,
                "description": "The agent id returned by the tool."
              },
              {
                "type": "null",
                "description": "The agent id returned by the tool."
              }
            ],
            "description": "The agent id returned by the tool."
          },
          "assistant_id": {
            "anyOf": [
              {
                "type": "string",
                "minLength": 1,
                "description": "The assistant id returned by the tool."
              },
              {
                "type": "null",
                "description": "The assistant id returned by the tool."
              }
            ],
            "description": "The assistant id returned by the tool."
          },
          "enabled": {
            "type": "boolean",
            "description": "The enabled returned by the tool."
          },
          "platform_team_id": {
            "type": [
              "string",
              "null"
            ],
            "description": "The platform team id returned by the tool."
          },
          "platform_bot_id": {
            "type": [
              "string",
              "null"
            ],
            "description": "The platform bot id returned by the tool."
          },
          "workspace_name": {
            "type": [
              "string",
              "null"
            ],
            "description": "The workspace name returned by the tool."
          },
          "respond_to": {
            "type": "string",
            "enum": [
              "mentions",
              "direct_messages",
              "all"
            ],
            "description": "The respond to returned by the tool."
          },
          "allowed_slack_channel_ids": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "One allowed slack channel id item returned by the tool."
            },
            "description": "List of allowed slack channel ids returned by the tool."
          },
          "allowed_channels": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "One allowed channel item returned by the tool."
            },
            "description": "List of allowed channels returned by the tool."
          },
          "status": {
            "type": "string",
            "enum": [
              "connected",
              "needs_reauth",
              "error"
            ],
            "description": "Lifecycle status for the returned record."
          },
          "welcome_message": {
            "type": [
              "string",
              "null"
            ],
            "description": "The welcome message returned by the tool."
          },
          "error_message": {
            "type": [
              "string",
              "null"
            ],
            "description": "The error message returned by the tool."
          },
          "max_response_tokens": {
            "anyOf": [
              {
                "type": "integer",
                "exclusiveMinimum": 0,
                "description": "The max response tokens returned by the tool."
              },
              {
                "type": "null",
                "description": "The max response tokens returned by the tool."
              }
            ],
            "description": "The max response tokens returned by the tool."
          },
          "runtime_target_kind": {
            "type": "string",
            "enum": [
              "main_branch",
              "environment",
              "preview_branch"
            ],
            "description": "The runtime target kind returned by the tool."
          },
          "target_environment_id": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid",
                "description": "The target environment id returned by the tool."
              },
              {
                "type": "null",
                "description": "The target environment id returned by the tool."
              }
            ],
            "description": "The target environment id returned by the tool."
          },
          "target_branch_id": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid",
                "description": "The target branch id returned by the tool."
              },
              {
                "type": "null",
                "description": "The target branch id returned by the tool."
              }
            ],
            "description": "The target branch id returned by the tool."
          },
          "resolved_target": {
            "type": "object",
            "properties": {
              "runtime_target": {
                "type": "object",
                "properties": {
                  "kind": {
                    "$ref": "#/properties/data/items/properties/runtime_target_kind",
                    "description": "The kind returned by the tool."
                  },
                  "target_environment_id": {
                    "anyOf": [
                      {
                        "type": "string",
                        "format": "uuid",
                        "description": "The target environment id returned by the tool."
                      },
                      {
                        "type": "null",
                        "description": "The target environment id returned by the tool."
                      }
                    ],
                    "description": "The target environment id returned by the tool."
                  },
                  "target_branch_id": {
                    "anyOf": [
                      {
                        "type": "string",
                        "format": "uuid",
                        "description": "The target branch id returned by the tool."
                      },
                      {
                        "type": "null",
                        "description": "The target branch id returned by the tool."
                      }
                    ],
                    "description": "The target branch id returned by the tool."
                  }
                },
                "required": [
                  "kind",
                  "target_environment_id",
                  "target_branch_id"
                ],
                "additionalProperties": false,
                "description": "Structured runtime target details returned by the tool."
              },
              "resolved_environment": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "format": "uuid",
                        "description": "Unique identifier for the returned record."
                      },
                      "name": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "Human-readable name for the returned record."
                      }
                    },
                    "required": [
                      "id",
                      "name"
                    ],
                    "additionalProperties": false,
                    "description": "Structured resolved environment details returned by the tool."
                  },
                  {
                    "type": "null",
                    "description": "The resolved environment returned by the tool."
                  }
                ],
                "description": "The resolved environment returned by the tool."
              },
              "resolved_branch": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "format": "uuid",
                        "description": "Unique identifier for the returned record."
                      },
                      "name": {
                        "type": "string",
                        "description": "Human-readable name for the returned record."
                      }
                    },
                    "required": [
                      "id",
                      "name"
                    ],
                    "additionalProperties": false,
                    "description": "Structured resolved branch details returned by the tool."
                  },
                  {
                    "type": "null",
                    "description": "The resolved branch returned by the tool."
                  }
                ],
                "description": "The resolved branch returned by the tool."
              },
              "resolved_deployment": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "Unique identifier for the returned record."
                      },
                      "runtime_version": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The runtime version returned by the tool."
                      },
                      "deployment_revision": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The deployment revision returned by the tool."
                      },
                      "last_deployed_at": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The last deployed at returned by the tool."
                      }
                    },
                    "required": [
                      "id",
                      "runtime_version",
                      "deployment_revision",
                      "last_deployed_at"
                    ],
                    "additionalProperties": false,
                    "description": "Structured resolved deployment details returned by the tool."
                  },
                  {
                    "type": "null",
                    "description": "The resolved deployment returned by the tool."
                  }
                ],
                "description": "The resolved deployment returned by the tool."
              },
              "resolved_managed_domain": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "domain": {
                        "type": "string",
                        "description": "The domain returned by the tool."
                      },
                      "health_url": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The health url returned by the tool."
                      }
                    },
                    "required": [
                      "domain",
                      "health_url"
                    ],
                    "additionalProperties": false,
                    "description": "Structured resolved managed domain details returned by the tool."
                  },
                  {
                    "type": "null",
                    "description": "The resolved managed domain returned by the tool."
                  }
                ],
                "description": "The resolved managed domain returned by the tool."
              },
              "resolved_invoke_mode": {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "dispatch_override",
                      "managed_domain"
                    ],
                    "description": "The resolved invoke mode returned by the tool."
                  },
                  {
                    "type": "null",
                    "description": "The resolved invoke mode returned by the tool."
                  }
                ],
                "description": "The resolved invoke mode returned by the tool."
              },
              "last_resolution_error": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "code": {
                        "type": "string",
                        "description": "The code returned by the tool."
                      },
                      "retryable": {
                        "type": "boolean",
                        "description": "The retryable returned by the tool."
                      },
                      "message": {
                        "type": "string",
                        "description": "The message returned by the tool."
                      }
                    },
                    "required": [
                      "code",
                      "retryable",
                      "message"
                    ],
                    "additionalProperties": false,
                    "description": "Structured last resolution error details returned by the tool."
                  },
                  {
                    "type": "null",
                    "description": "The last resolution error returned by the tool."
                  }
                ],
                "description": "The last resolution error returned by the tool."
              }
            },
            "required": [
              "runtime_target",
              "resolved_environment",
              "resolved_branch",
              "resolved_deployment",
              "resolved_managed_domain",
              "resolved_invoke_mode",
              "last_resolution_error"
            ],
            "additionalProperties": false,
            "description": "Structured resolved target details returned by the tool."
          },
          "created_at": {
            "type": "string",
            "description": "Creation timestamp in ISO 8601 format."
          },
          "updated_at": {
            "type": "string",
            "description": "Last update timestamp in ISO 8601 format."
          }
        },
        "required": [
          "id",
          "project_id",
          "binding_id",
          "installation_id",
          "platform",
          "name",
          "agent_id",
          "assistant_id",
          "enabled",
          "platform_team_id",
          "platform_bot_id",
          "workspace_name",
          "respond_to",
          "allowed_slack_channel_ids",
          "allowed_channels",
          "status",
          "welcome_message",
          "error_message",
          "max_response_tokens",
          "runtime_target_kind",
          "target_environment_id",
          "target_branch_id",
          "resolved_target",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false,
        "description": "One data item returned by the tool."
      },
      "description": "All project channels, newest first by creation time then ID. This complete list is not paginated."
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Structured result returned by the list_channels tool."
}
```

<details>
  <summary>Try this tool</summary>

  Replace sample arguments with values for your project or connected account. Calls run only when you select Run tool.

  MCP tool call

  Call `veryfront__list_channels` against the Veryfront MCP endpoint.

  Bearer token or API key

  Arguments (JSON)

  Run tool

  Output JSON

  <pre />
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.