Skip to main content

Get Workspace

Method GET​

https://my.easyweek.io/api/public/v2/workspace

Description: This endpoint retrieves details about a specific workspace. It provides key information including the workspace's name, slug, and description, along with various settings and configurations.

Example Request​

curl -i -X GET \
  https://my.easyweek.io/api/public/v2/workspace \
  -H 'Authorization: Bearer <YOUR_SECRET>' \
  -H 'Workspace: <YOUR_WORKSPACE>'

Example Response​

{
  "uuid": "d679011b-f488-4fc4-a436-89b1e6d7e14b",
  "name": "Your company GmbH",
  "slug": "company-gmbh",
  "icon": "https://example.com/icon.png",
  "logo": "https://example.com/logo.png",
  "domain": "demo-gmbh.eyw.me",
  "country_iso": "Germany",
  "locale": "de",
  "currency": "EUR",
  "time_format": "24h",
  "first_week_day": "monday",
  "html_dir": "ltr",
  "languages": [
    "de"
  ],
  "language_default": "de",
  "theme": "light",
  "custom_colors": {
    "surface": "#ffffff",
    "on-surface": "#383868",
    "primary": "#36ab48",
    "secondary": "#ffffff"
  },
  "socials": {
    "instagram": "https://www.instagram.com/example",
    "facebook": "https://www.facebook.com/example",
    "tiktok": "https://www.tiktok.com/example",
    "youtube": "https://www.youtube.com/example",
    "twitter": "https://www.x.com/@example"
  },
  "contacts": {
    "phone": "+493012345678",
    "whatsapp": "+493012345678",
    "viber": "+493012345678",
    "telegram": "@example"
  }
}