Identity

GET /me is the cheapest call you can make. It tells you what the bearer token is: granted scopes, organization, workspace binding, plan tier, and the current month's API quota usage with caps and reset time. Use it as a connectivity check from a fresh deploy, when debugging an auth issue, or to show your users how much API headroom they have left.

Base path: https://api.shortsync.app/v1

EndpointMethodPathScopePurpose
Get identityGET/meanyScopes, organization, workspace, plan, monthly quota

Get identity

GET/me·any

Any valid token works. No scope is required. Returns the key metadata that the rest of the API gates on, plus the current month's API quota snapshot.

Example request

bash
curl https://api.shortsync.app/v1/me \
  -H "Authorization: Bearer $TOKEN"

Example response

json
{
  "kind": "workspace",
  "key_id": "0425b194-e9c1-4eca-ba35-ddd1ca84d7e9",
  "prefix": "ss_live_iUqoW6fj",
  "organization_id": "55c3dca4-1a0e-4fe9-8ece-895b477fce91",
  "workspace_id": "bbdeeb40-c106-4ed6-95b5-c0e76086c957",
  "scopes": ["posts:write", "posts:read", "uploads:write", "connections:read"],
  "plan": "team",
  "quota": {
    "requests": { "used": 1247, "limit": 500000, "remaining": 498753 },
    "resets_at": "2026-07-01T00:00:00.000Z"
  }
}

Response fields

FieldTypeDescription
kind"workspace"Always workspace. The field is kept on the response shape for forward compatibility.
key_idstringThe API key's UUID. Use this to identify the key in usage logs.
prefixstringThe visible portion of the token (e.g. ss_live_iUqoW6fj). Safe to log; the secret half is never returned again after creation.
organization_idstringUUID of the organization the token belongs to.
workspace_idstringUUID of the workspace this key publishes for.
scopesstring[]The granted scopes. Workspace keys default to posts:read, posts:write, uploads:write, connections:read.
plan"creator" | "team"Plan tier of the organization this key belongs to.
quotaobjectCurrent calendar-month API request usage and cap for the organization. requests counts every authenticated /api/v1/* call. Caps come from the plan tier (Creator: 50 000 requests; Team: 500 000 requests). There is no per-post cap. Paid plans get unlimited publishes. Counts reset at resets_at (first day of next UTC month). Hitting the cap returns 429 QUOTA_EXCEEDED on the call that would have pushed you past it.

Scope: the cap is per organization (subscription), shared across every API key the organization mints. Rotating or adding keys does not reset the counter or multiply the cap.

Errors

FieldTypeDescription
401 INVALID_KEYerrorThe Bearer token is missing, malformed, revoked, or expired.
429 QUOTA_EXCEEDEDerrorThe organization has used up its monthly API request quota.