Users

Manage the authenticated user’s own profile. Every endpoint in this group operates on “me” — there is no way to look up another user by ID through this API.

Base URL

https://api.voxburst.io/v1/users

Get Current User Profile

GET /v1/users/me

curl https://api.voxburst.io/v1/users/me \
  -H "Authorization: Bearer <cognito-token>"

Response

{
  "id": "usr_example456",
  "email": "jane@example.com",
  "name": "Jane Doe",
  "avatarUrl": "https://cdn.voxburst.io/avatars/user/usr_example456/1.png",
  "externalId": "a1b2c3d4-cognito-sub",
  "createdAt": "2026-01-15T00:00:00.000Z",
  "updatedAt": "2026-06-01T00:00:00.000Z",
  "isSystemAdmin": false,
  "workspaces": [
    {
      "id": "wsp_example123",
      "name": "Acme Co",
      "slug": "acme-co",
      "logo": null,
      "plan": "pro",
      "logoUrl": null,
      "role": "OWNER",
      "joinedAt": "2026-01-15T00:00:00.000Z"
    }
  ]
}

Response Fields

Update Current User Profile

PATCH /v1/users/me

All fields optional — send only what you want to change.

curl -X PATCH https://api.voxburst.io/v1/users/me \
  -H "Authorization: Bearer <cognito-token>" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Jane R. Doe" }'

Error Codes

Delete Current User Account

DELETE /v1/users/me

Deletes the account. Workspace memberships cascade-delete with it. If the account has a paid subscription that is still set to renew, deletion cancels it for you — you do not need to call POST /v1/billing/cancel first. Cancellation is cancel_at_period_end: no future charge is made, and no refund is issued for the period already paid for.

If the cancellation cannot be confirmed with Stripe, the account is not deleted and the call returns 503 SUBSCRIPTION_CANCEL_FAILED. Nothing is changed; retry. This is deliberate: deleting the account while a live subscription keeps renewing would leave the customer being billed with no account from which to cancel.

curl -X DELETE https://api.voxburst.io/v1/users/me \
  -H "Authorization: Bearer <cognito-token>"

Error Codes

List Current User’s Workspaces

GET /v1/users/me/workspaces

Similar to the workspaces array on GET /v1/users/me, but includes member/account/post counts per workspace and no isSystemAdmin field.

curl https://api.voxburst.io/v1/users/me/workspaces \
  -H "Authorization: Bearer <cognito-token>"

Response

{
  "data": [
    {
      "id": "wsp_example123",
      "name": "Acme Co",
      "slug": "acme-co",
      "logo": null,
      "logoUrl": null,
      "plan": "pro",
      "role": "OWNER",
      "settings": {},
      "joinedAt": "2026-01-15T00:00:00.000Z",
      "memberCount": 3,
      "accountCount": 8,
      "postCount": 214
    }
  ],
  "total": 1
}

Create a Workspace for the Current User

POST /v1/users/me/workspaces

curl -X POST https://api.voxburst.io/v1/users/me/workspaces \
  -H "Authorization: Bearer <cognito-token>" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Second Brand", "slug": "second-brand" }'

The caller becomes OWNER of the new workspace.

Error Codes

Export Personal Data (GDPR)

GET /v1/users/me/export

Returns a JSON file containing the personal data VoxBurst holds for the user: profile, notification preferences, workspace memberships, posts the user created, connected social accounts (no tokens/credentials), and personas. Rate limited to 1 request per hour per user.

curl https://api.voxburst.io/v1/users/me/export \
  -H "Authorization: Bearer <cognito-token>" \
  -o voxburst-data-export.json

The response is returned with Content-Disposition: attachment so browser clients trigger a file download.

Error Codes

Store GA4 Client ID

POST /v1/users/me/ga4-client-id

Internal analytics-stitching endpoint used by the VoxBurst dashboard to associate a browser GA4 client ID with the authenticated user for server-side event attribution.

curl -X POST https://api.voxburst.io/v1/users/me/ga4-client-id \
  -H "Authorization: Bearer <cognito-token>" \
  -H "Content-Type: application/json" \
  -d '{ "clientId": "1234567890.1234567890" }'

clientId must match the GA4 client ID format (\d+\.\d+).

Error Codes