squidX logo
Open squidX

Workspace

Who the key is, and the settings a scheduler needs before it writes anything: timezone, weekly posting slots, X Communities and the automation defaults every new post inherits.

Get the current key

GETsquidx.io/api/v1/meworkspace:read

The workspace this key belongs to, its permissions and the X account the workspace publishes as. The first call to make after creating a key.

Request
curl https://squidx.io/api/v1/me \
  -H "Authorization: Bearer sqx_your_key"
Response · 200
{
  "data": {
    "workspace": {
      "id": "3c1c9e5a-0d2b-4f6e-8a7c-1b2d3e4f5a6b",
      "name": "squidX",
      "plan": "growth",
      "timezone": "Europe/Paris",
      "createdAt": "2026-07-03T12:00:00.000Z"
    },
    "key": {
      "id": "f0e1d2c3-b4a5-4f6e-9d8c-7b6a5f4e3d2c",
      "name": "Claude Code",
      "scopes": [
        "workspace:read",
        "posts:read",
        "posts:write",
        "posts:publish"
      ]
    },
    "x": {
      "connected": true,
      "handle": "aschapmann",
      "displayName": "Axel Schapmann",
      "avatarUrl": "https://pbs.twimg.com/profile_images/.../photo.jpg",
      "canPublish": true,
      "connectedAt": "2026-07-04T10:15:00.000Z"
    }
  }
}

Get workspace settings

GETsquidx.io/api/v1/workspaceworkspace:read

Timezone, posting slots, communities, writing preferences and automation defaults. Slots are wall-clock entries in the workspace timezone: dow is ISO (1 = Monday, 7 = Sunday), minutes counts from midnight.

Request
curl https://squidx.io/api/v1/workspace \
  -H "Authorization: Bearer sqx_your_key"
Response · 200
{
  "data": {
    "id": "3c1c9e5a-0d2b-4f6e-8a7c-1b2d3e4f5a6b",
    "name": "squidX",
    "plan": "growth",
    "timezone": "Europe/Paris",
    "createdAt": "2026-07-03T12:00:00.000Z",
    "postingSlots": [
      {
        "dow": 1,
        "minutes": 540
      },
      {
        "dow": 3,
        "minutes": 540
      },
      {
        "dow": 5,
        "minutes": 1020
      }
    ],
    "communities": [
      {
        "id": "1493446837214187523",
        "name": "Build in Public"
      }
    ],
    "writing": {
      "language": "en",
      "longPosts": true
    },
    "autoReply": {
      "enabled": true,
      "threshold": 20,
      "text": "More on this: https://squidx.io"
    },
    "autoRetweet": {
      "enabled": false,
      "delayHours": 24
    },
    "x": {
      "connected": true,
      "handle": "aschapmann",
      "canPublish": true
    }
  }
}