List all workspaces

This API endpoint fetches a list of all workspaces.

This endpoint will list all the workspaces on your account.

Endpoint

cURL

GET https://api.mailstand.com/workspaces

Parameters

Field	Required	Description
search	false	This will search by workspace name.

200 Response

JSON

{
    status: "ok",
    data: [
        {
            id: "space_PO6fCH6vqL8TxdSjVhpL8i5Kp",
            name: "First Workspace",
            color: "#37C23C",
            campaign_count: 0
        },
        {
            id: "space_YHrEEnNePJEqeMyPW9m4CJqD2",
            name: "Second Workspace",
            color: "#3339FF",
            campaign_count: 1
        },
        {
            id: "space_d5X7Byb2xTPjnopQzHs8QQHnj",
            name: "Third Workspace",
            color: "#ABCERF",
            campaign_count: 3
        }
    ]
}

Response Fields

Field	Type	Description
id	string	Unique identifier of the workspace. It always starts with space_.
name	string	The name of the workspace.
color	string	The color label of the workspace in hex code.
campaign_count	number	The number of campaigns that exist on the workspace.