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

​
Parameters

ParameterDescription
Component ModelThe identifier of the Ardoq model used by the workspace to filter by.
Workspace NameThe name of the workspace to filter by.

​
Example Output

{
	"values": [
		{
			"_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"
			},
			"_id": "02d85ec9e4d1a9b9d6e380e4",
			"_version": 1,
			"name": "My First Workspace",
			"description": "My favorite workspace",
			"views": [
				"blockDiagram",
				"tableView"
			],
			"startView": "blockDiagram",
			"workspaceKey": "ABC"
		}
	],
	"_links": {
		"next": {
			"href": "string"
		}
	},
	"_meta": {
		"property1": null,
		"property2": null
	}
}

​
Workflow Library Example

List Workspaces with Ardoq and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop