---
updatedAt: 2025-05-19T20:30:15.000Z
agentTools:
  projectIndex: https://developers.pocketsmith.com/llms.txt
---

# Get the authorised user

Gets the user that corresponds to the access token used in the request.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "PocketSmith",
    "description": "The PocketSmith API",
    "contact": {
      "name": "API Support",
      "email": "api@pocketsmith.com"
    },
    "version": "2.0"
  },
  "x-samples-languages": [
    "curl",
    "node",
    "javascript",
    "php",
    "python"
  ],
  "servers": [
    {
      "url": "https://api.pocketsmith.com/v2",
      "description": "Production"
    }
  ],
  "components": {
    "securitySchemes": {
      "developerKey": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Developer-Key",
        "description": "If you want to build a tool just for yourself, be it a desktop widget to display your balances or a tool to import transactions from a bank without a bank feed, you can use our developer keys feature. You can issue yourself a key which will give you persistent API access to just your account. You should rotate your keys regularly."
      }
    },
    "responses": {
      "403": {
        "description": "Not Allowed",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    },
    "schemas": {
      "User": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique identifier of the user.",
            "example": 42
          },
          "login": {
            "type": "string",
            "description": "The user's username.",
            "example": "sampleuser69"
          },
          "name": {
            "type": "string",
            "description": "The full name of the user, although not all users will have a name set.",
            "example": "Foo Barrington"
          },
          "email": {
            "type": "string",
            "description": "The user's email address.",
            "example": "user69@sample.com"
          },
          "avatar_url": {
            "type": "string",
            "description": "The URL to the user's avatar.",
            "example": "https://image.com/image.png"
          },
          "beta_user": {
            "type": "boolean",
            "description": "Whether the user has opted in to beta features.",
            "example": true
          },
          "time_zone": {
            "type": "string",
            "description": "The user's time zone.",
            "example": "Auckland"
          },
          "week_start_day": {
            "type": "integer",
            "description": "The day of the week the user wishes their calendars to start on. A number between 0 and 6, where 0 is Sunday and 6 is Saturday.",
            "example": 1
          },
          "is_reviewing_transactions": {
            "type": "boolean",
            "description": "Whether the user wants to review new transactions, transfer transactions or categorisation.",
            "example": true
          },
          "base_currency_code": {
            "type": "string",
            "description": "The user's base currency.",
            "example": "NZD"
          },
          "always_show_base_currency": {
            "type": "boolean",
            "description": "Whether the user wants to see all accounts in their base currency instead of the native account currency.",
            "example": false
          },
          "using_multiple_currencies": {
            "type": "boolean",
            "description": "Whether the user has multiple currencies in use across their account.",
            "example": true
          },
          "available_accounts": {
            "type": "integer",
            "description": "The user's total number of available accounts.",
            "example": 3
          },
          "available_budgets": {
            "type": "integer",
            "description": "The user's total number of available budgets.",
            "example": 3
          },
          "forecast_last_updated_at": {
            "type": "string",
            "description": "When the user's forecast was last updated.",
            "example": "2015-07-02T22:14:49Z"
          },
          "forecast_last_accessed_at": {
            "type": "string",
            "description": "When the user's forecast was last accessed.",
            "example": "2015-07-02T22:14:49Z"
          },
          "forecast_start_date": {
            "type": "string",
            "description": "The date that the user's forecast starts.",
            "example": "2015-07-01"
          },
          "forecast_end_date": {
            "type": "string",
            "description": "The date that the user's forecast ends.",
            "example": "2015-07-15"
          },
          "forecast_defer_recalculate": {
            "type": "boolean",
            "description": "Whether the user's forecast recalculation should be deferred.",
            "example": false
          },
          "forecast_needs_recalculate": {
            "type": "boolean",
            "description": "Whether the user's forecast needs to be recalculated.",
            "example": true
          },
          "last_logged_in_at": {
            "type": "string",
            "description": "When the user last logged into PocketSmith.",
            "example": "2015-07-02T22:14:49Z"
          },
          "last_activity_at": {
            "type": "string",
            "description": "When the user last interacted with PocketSmith, via any application or the API.",
            "example": "2015-07-02T22:14:49Z"
          },
          "created_at": {
            "type": "string",
            "description": "When the user signed up.",
            "example": "2015-07-02T22:14:49Z"
          },
          "updated_at": {
            "type": "string",
            "description": "When the user was last updated.",
            "example": "2015-07-02T22:14:49Z"
          }
        }
      },
      "Error": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "description": "A message describing the error that occurred.",
            "example": "A message describing the error that occurred."
          }
        }
      }
    }
  },
  "paths": {
    "/me": {
      "get": {
        "summary": "Get the authorised user",
        "description": "Gets the user that corresponds to the access token used in the request.",
        "tags": [
          "Users"
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/User"
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/403"
          }
        }
      }
    }
  },
  "security": [
    {
      "developerKey": []
    }
  ]
}
```