Skip to main content
GET
/
workspaces
Get user workspaces
curl --request GET \
  --url https://api.breakcold.com/rest/workspaces \
  --header 'X-API-KEY: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "avatar_url": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "tracking_domain": "<string>",
    "language": "<string>",
    "team_size": "<string>",
    "source": "<string>",
    "default_currency": "<string>",
    "default_phone_country": "<string>",
    "organizationId": "<string>",
    "organization": {
      "id": "<string>",
      "name": "<string>"
    }
  }
]

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
full
boolean
default:false
​
role
boolean
default:false

Response

Successful response

​
id
string
required
​
name
string | null
required
​
avatar_url
string | null
required
​
created_at
string | null
required
​
updated_at
string | null
required
​
tracking_domain
string | null
required
​
language
string | null
required
​
team_size
string | null
required
​
source
string | null
required
​
default_currency
string
required
​
default_phone_country
string | null
required
​
organizationId
string
required
​
organization
object