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

# List Components

List all components, optionally filtering them using the provided parameters.

<Note>
  External Documentation

  To learn more, visit the [Ardoq documentation](https://developer.ardoq.com/public-api/#tag/Components/paths/~1api~1v2~1components/get).
</Note>

## Parameters

<div className="integrations-table">
  | Parameter      | Description                                                                                                                                                                                                           |
  | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Component Key  | The component key to filter by.                                                                                                                                                                                       |
  | Component Name | The name of the component to filter by.                                                                                                                                                                               |
  | Custom Fields  | Custom fields to filter by.<br /><br />Key format: `customFields.{my_field}`<br /><br />For more information, please refer to [Ardoq's documentation](https://developer.ardoq.com/api-guides/concepts/customfields/). |
  | Parent         | The parent ID of the component to filter by.                                                                                                                                                                          |
  | Root Workspace | The ID of the workspace the component belongs to, used for filtering.                                                                                                                                                 |
  | Type ID        | The type ID of the component to filter by.                                                                                                                                                                            |
</div>

## Example Output

```json theme={"dark"}
{
	"values": [
		{
			"rootWorkspace": "94853cafda12fddbb3b1090b",
			"shape": "terminal",
			"image": "/api/attachment/workspace/123456789abcdef123456789/index.jpg",
			"parent": "6acd7fb66749930a11f4b7a3",
			"name": "My Component",
			"_meta": {
				"created": "2025-01-31T12:19:53.898Z",
				"createdBy": "af51f10f1e353d50568a945d",
				"lastUpdated": "2025-01-31T12:20:25.218Z",
				"lastModifiedBy": "7c53e66bc17d8b106c84eca9",
				"createdByEmail": "creator@ardoq.com",
				"createdByName": "Mr. Ardoq",
				"lastModifiedByEmail": "updater@ardoq.com",
				"lastModifiedByName": "Ms. Ardoq"
			},
			"typeId": "p8157715174806",
			"type": "Decision",
			"_id": "f6ff8985b039be3fd288c2d5",
			"_version": 1,
			"componentKey": "BIZ-1234",
			"color": "rgba(72,72,72,1)",
			"description": "My favorite component",
			"customFields": {
				"property1": null,
				"property2": null
			},
			"icon": "road"
		}
	],
	"_links": {
		"next": {
			"href": "string"
		}
	},
	"_meta": {
		"property1": null,
		"property2": null
	}
}
```

## Workflow Library Example

[List Components with Ardoq and Send Results Via Email](https://library.blinkops.com/workflows/list-components-with-ardoq-and-send-results-via-email)

<div className="iframe-wrapper">
  <div className="iframe-media">
    <img src="https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max&auto=format&n=ojHYuDeYX5FWuN8a&q=85&s=b8af968e71438a9499c3223c9bd29fb2" alt="Workflow Library" width="16" height="16" data-path="img/Icons/play-box.svg" />

    Preview this Workflow on desktop
  </div>

  <iframe className="iframe" src="https://library.blinkops.com/workflows/list-components-with-ardoq-and-send-results-via-email/canvas" />
</div>