> This page is for Designer API.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.webflow.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.webflow.com/_mcp/server.

# Get component by name (Beta)

## `webflow.getComponentByName(name)`

## `webflow.getComponentByName(group, name)`

Retrieves a component based on its name and optionally its group.

Component names are case-sensitive.

> **Beta**
>
> These methods are in public beta and may change with future releases.

### Syntax

Get a component by its name:

```typescript
webflow.getComponentByName(name: string): Promise<Component>
```

Get a component by its name and group:

```typescript
webflow.getComponentByName(group: string, name: string): Promise<Component>
```

### Returns

**Promise\<*Component*>**

A Promise that resolves to a component.

### Example

```typescript
// Fetch a component by name only
const heroSection = await webflow.getComponentByName('Hero');
console.log(heroSection.id);

// Fetch a component scoped to a group
const marketingHero = await webflow.getComponentByName('Marketing', 'Hero');
console.log(marketingHero.id);
```

[Try this example](https://webflow.com/oauth/authorize?response_type=code\&client_id=19511de1ec410f9228d8dcbc9420e67916dea80d86d18f0c9a533eb475ea0f62)

---

### Designer Ability

Checks for authorization only

| Designer Ability    | Permission | Locale | Branch | Workflow | Sitemode |
| :------------------ | :--------- | :----- | :----- | :------- | :------- |
| **canAccessCanvas** | any        | any    | any    | any      | any      |