> For the complete documentation index, see [llms.txt](https://docs.shortcutco.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shortcutco.com/developers/api-reference/reference/meta.md).

# Meta

The token making the request and its workspace.

`GET /v1/me` needs no scope, so it is the first call to make with a new token: it confirms the token works and names its workspace, the workspace's timezone, and today's date there.

Fields: [The token object](https://docs.shortcutco.com/developers/reference/objects/token).

## Get the current token

> Returns the token's name, kind, and scopes, the workspace it belongs to with its timezone, and the current rate-limit window. Use it to check a new token works.\
> \
> Returns \[the token object]\(<https://docs.shortcutco.com/developers/reference/objects/token>).

```json
{"openapi":"3.1.0","info":{"title":"Shortcut API","version":"v1"},"tags":[{"name":"Meta","description":"`GET /v1/me` needs no scope, so it is the first call to make with a new token: it confirms the token works and names its workspace, the workspace's timezone, and today's date there.\n\nFields: [The token object](https://docs.shortcutco.com/developers/reference/objects/token)."}],"servers":[{"url":"https://api.shortcutco.com","description":"Production"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"scut_<env>_<id>_<secret>","description":"A workspace API token. Each operation lists the scopes it needs; `write` implies `read`, and `send`/`complete` are never implied."}},"headers":{"RateLimitLimit":{"schema":{"type":"integer"},"description":"Requests allowed in the tightest window."},"RateLimitRemaining":{"schema":{"type":"integer"},"description":"Requests left in that window."},"RateLimitReset":{"schema":{"type":"integer"},"description":"Seconds until that window resets."}},"schemas":{"Token":{"type":"object","properties":{"object":{"type":"string","const":"token","description":"Always `token`."},"token":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The token's id."},"name":{"type":"string","description":"The name given to the token in Settings."},"kind":{"type":"string","enum":["api_key","oauth_access"],"description":"`api_key` for tokens created in Settings."},"scopes":{"type":"array","items":{"type":"string","enum":["customers:read","customers:write","leads:read","leads:write","estimates:read","estimates:write","estimates:send","jobs:read","jobs:write","visits:read","visits:write","visits:complete","invoices:read","invoices:write","invoices:send","payments:read","payments:write","services:read","services:write","products:read","products:write","tags:read","tags:write","custom_fields:read","teams:read","users:read","webhooks:manage","automations:trigger"]},"description":"The scopes this token holds."}},"required":["id","name","kind","scopes"],"additionalProperties":false,"description":"The token making the request."},"workspace":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The workspace's id."},"name":{"type":"string","description":"The workspace's business name."},"timezone":{"type":"string","description":"IANA timezone that date-only values such as visit dates use."},"today":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Today's date in the workspace's timezone, `YYYY-MM-DD`."}},"required":["id","name","timezone","today"],"additionalProperties":false,"description":"The workspace the token belongs to."},"rateLimit":{"type":"object","properties":{"limit":{"type":"integer","description":"Requests allowed in the tightest current window."},"remaining":{"type":"integer","description":"Requests left in that window."},"resetSeconds":{"type":"integer","description":"Seconds until that window resets."}},"required":["limit","remaining","resetSeconds"],"additionalProperties":false,"description":"The token's tightest rate-limit window right now."}},"required":["object","token","workspace","rateLimit"],"additionalProperties":false,"description":"The token making the request and its workspace."},"Error":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","description":"Error family, such as `invalid_request` or `permission`."},"code":{"type":"string","description":"Specific error code; see the errors page."},"message":{"type":"string","description":"A human-readable explanation."},"param":{"type":"string","description":"The input the error is about, such as `query.limit`."},"requiredScope":{"type":"string","description":"The scope the token is missing."},"requestId":{"type":"string","description":"Quote this id to support."},"docs":{"type":"string","description":"Link to the error's documentation."}},"required":["type","code","message","requestId","docs"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthenticated":{"description":"The token is missing, invalid, expired, or revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"SubscriptionRequired":{"description":"The workspace's subscription needs attention.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Forbidden":{"description":"The token is missing a required scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"No such object in this workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"RateLimited":{"description":"Rate limited; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"InternalError":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unavailable":{"description":"Temporarily unavailable; retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/v1/me":{"get":{"operationId":"me.get","tags":["Meta"],"summary":"Get the current token","description":"Returns the token's name, kind, and scopes, the workspace it belongs to with its timezone, and the current rate-limit window. Use it to check a new token works.\n\nReturns [the token object](https://docs.shortcutco.com/developers/reference/objects/token).","parameters":[],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Token"},"meta":{"type":"object","properties":{},"additionalProperties":true,"description":"Facts about this request beside the object, such as `alreadyReminded` on a repeated reminder. Present only when there is something to report."}},"required":["data"],"additionalProperties":false}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"402":{"$ref":"#/components/responses/SubscriptionRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"}}}}}}
```