Get Started

Workspaces

API endpoint for managing workspaces. Supports retrieving, updating, and deleting workspaces. Returns all workspaces the authenticated user is a member of, or all workspaces if the user is an admin.

GETPATCHDELETE
PATCH/workspaces

Request Body

requiredapplication/json
namestring

Workspace name. If updated, the slug will be automatically regenerated.

Example: "My Updated Workspace"

industryenum
Allowed values: Mobile App, SaaS, E-commerce, Marketing Agency, Content Creator, Consulting, Non-profit, Education, Healthcare, Finance, Real Estate, Other
websiteUrlstring | null

Workspace website URL. Can be null to remove.

Example: "https://example.com"

appstoreUrlstring | null

App Store URL. Can be null to remove.

Example: "https://apps.apple.com/app/example"

instagramUrlstring | null

Instagram URL. Can be null to remove.

Example: "https://instagram.com/example"

logoUrlstring | null

URL to workspace logo. Can be null to remove.

Example: "https://example.com/logo.png"

currencyCodeenum

ISO 4217 currency code

Example: "USD"

Allowed values: USD, EUR, GBP, CAD, AUD, NZD, JPY, CNY, INR, BRL, MXN, CHF, SEK, NOK, DKK, PLN, CZK, HUF, RON, BGN, ILS, AED, SAR, ZAR, HKD, SGD, KRW, THB, IDR, MYR, PHP, ARS, CLP, COP, PEN

Headers

x-api-keystringrequired

Your Track My Posts API key

Query Parameters

workspaceSlugstringrequired

Workspace slug identifier

Example: my-workspace

Responses

200Workspace updated successfully
400Bad request - validation error
401Unauthorized - authentication required
403Forbidden - insufficient permissions
404Not found - workspace not found
500Internal server error
curl "https://api.trackmyposts.com/workspaces?workspaceSlug=my-workspace" \
  -X PATCH \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Updated Workspace Name",
  "industry": "SaaS",
  "websiteUrl": "https://example.com",
  "currencyCode": "USD"
}'
{
  "ok": true,
  "newSlug": "updated-workspace-name"
}

Data Structures

View all 5 data structuresWorkspaces

Explore all data structures used in this API endpoint