Skip to main content
List all components, optionally filtering them using the provided parameters.
External DocumentationTo learn more, visit the Ardoq documentation.

​
Parameters

ParameterDescription
Component KeyThe component key to filter by.
Component NameThe name of the component to filter by.
Custom FieldsCustom fields to filter by.

Key format: customFields.{my_field}

For more information, please refer to Ardoq’s documentation.
ParentThe parent ID of the component to filter by.
Root WorkspaceThe ID of the workspace the component belongs to, used for filtering.
Type IDThe type ID of the component to filter by.

​
Example Output

{
	"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
Workflow LibraryPreview this Workflow on desktop
⌘I