> 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/objects/token.md).

# The token object

The token object in the Shortcut API - every field, an example, and the endpoints that return it.

The token making the request and its workspace.

## Fields

| Field                    | Type                                              | Description                                                  |
| ------------------------ | ------------------------------------------------- | ------------------------------------------------------------ |
| `object`                 | `"token"`                                         | Always `token`.                                              |
| `token`                  | object                                            | The token making the request.                                |
| `token.id`               | id                                                | The token's id.                                              |
| `token.name`             | string                                            | The name given to the token in Settings.                     |
| `token.kind`             | `api_key`                                         | `api_key` for tokens created in Settings.                    |
| `token.scopes`           | array of [scopes](/developers/concepts/scopes.md) | The scopes this token holds.                                 |
| `workspace`              | object                                            | The workspace the token belongs to.                          |
| `workspace.id`           | id                                                | The workspace's id.                                          |
| `workspace.name`         | string                                            | The workspace's business name.                               |
| `workspace.timezone`     | string                                            | IANA timezone that date-only values such as visit dates use. |
| `workspace.today`        | date                                              | Today's date in the workspace's timezone, `YYYY-MM-DD`.      |
| `rateLimit`              | object                                            | The token's tightest rate-limit window right now.            |
| `rateLimit.limit`        | integer                                           | Requests allowed in the tightest current window.             |
| `rateLimit.remaining`    | integer                                           | Requests left in that window.                                |
| `rateLimit.resetSeconds` | integer                                           | Seconds until that window resets.                            |

## Example

```json
{
  "object": "token",
  "token": {
    "id": "4c4b06a3-4895-41ea-84df-7d314129b878",
    "name": "Website leads",
    "kind": "api_key",
    "scopes": [
      "customers:read"
    ]
  },
  "workspace": {
    "id": "131027ef-0f5a-4336-8ba4-9e7d07eed9c4",
    "name": "Greenline Lawn Care",
    "timezone": "America/Denver",
    "today": "2026-10-16"
  },
  "rateLimit": {
    "limit": 600,
    "remaining": 599,
    "resetSeconds": 60
  }
}
```

## Endpoints

| Endpoint     | What it does          |
| ------------ | --------------------- |
| `GET /v1/me` | Get the current token |