Composway Docs
Tool reference

List workspaces

List the current user's workspaces (id, title).

Tool name: list_workspaces

Cost: Free - not billed, and does not draw on a plan quota.

Read-only

This tool only reads. It never creates or changes anything, so an assistant may call it without asking you first.

List the current user's workspaces (id, title). Use this to find a workspaceId before creating or listing campaigns.

Parameters

This tool takes no parameters.

Full input JSON Schema
{
	"$schema": "https://json-schema.org/draft/2020-12/schema",
	"type": "object",
	"properties": {}
}

Response

Full output JSON Schema
{
	"$schema": "https://json-schema.org/draft/2020-12/schema",
	"type": "object",
	"properties": {
		"data": {
			"type": "array",
			"items": {
				"type": "object",
				"properties": {
					"id": {
						"type": "string",
						"format": "uuid",
						"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
					},
					"title": {
						"type": "string"
					},
					"websiteUrl": {
						"anyOf": [
							{
								"type": "string"
							},
							{
								"type": "null"
							}
						]
					},
					"campaigns": {
						"type": "array",
						"items": {
							"type": "object",
							"properties": {
								"id": {
									"type": "string",
									"format": "uuid",
									"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
								},
								"title": {
									"anyOf": [
										{
											"type": "string"
										},
										{
											"type": "null"
										}
									]
								},
								"status": {
									"type": "string"
								}
							},
							"additionalProperties": {}
						}
					},
					"status": {
						"type": "string"
					}
				},
				"required": ["id", "title", "status"],
				"additionalProperties": {}
			}
		}
	},
	"required": ["data"],
	"additionalProperties": false
}

On this page