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

# Get account

Gets an account by its ID.

# 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"
            }
          }
        }
      },
      "404": {
        "description": "Not Found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    },
    "schemas": {
      "Institution": {
        "type": "object",
        "properties": {
          "currency_code": {
            "type": "string",
            "description": "The currency code of the institution.",
            "example": "NZD"
          },
          "title": {
            "type": "string",
            "description": "The title of the institution.",
            "example": "Bank of Foo"
          },
          "updated_at": {
            "type": "string",
            "description": "When the institution was last updated.",
            "example": "2015-04-21T22:42:22Z"
          },
          "created_at": {
            "type": "string",
            "description": "When the institution was created.",
            "example": "2015-04-21T22:42:22Z"
          },
          "id": {
            "type": "integer",
            "description": "The unique identifier of the institution.",
            "example": 57
          }
        }
      },
      "Account": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique identifier of the account.",
            "example": 42
          },
          "title": {
            "type": "string",
            "description": "The title of the account.",
            "example": "Bank of Foo"
          },
          "currency_code": {
            "type": "string",
            "description": "The currency code for the account.",
            "example": "NZD"
          },
          "type": {
            "type": "string",
            "description": "The type of the account.",
            "enum": [
              "bank",
              "credits",
              "cash",
              "stocks",
              "mortgage",
              "loans",
              "vehicle",
              "property",
              "insurance",
              "other_asset",
              "other_liability"
            ],
            "example": "bank"
          },
          "is_net_worth": {
            "type": "boolean",
            "description": "Whether the account is a net worth asset.",
            "example": false
          },
          "primary_transaction_account": {
            "$ref": "#/components/schemas/TransactionAccount"
          },
          "primary_scenario": {
            "$ref": "#/components/schemas/Scenario"
          },
          "transaction_accounts": {
            "type": "array",
            "description": "All transaction accounts that compose the account, including the primary.",
            "items": {
              "$ref": "#/components/schemas/TransactionAccount"
            }
          },
          "scenarios": {
            "type": "array",
            "description": "All scenarios that compose the account, including the primary.",
            "items": {
              "$ref": "#/components/schemas/Scenario"
            }
          },
          "created_at": {
            "type": "string",
            "description": "When the account was created.",
            "example": "2018-02-27"
          },
          "updated_at": {
            "type": "string",
            "description": "When the account was last updated.",
            "example": "2018-02-27"
          },
          "current_balance": {
            "type": "number",
            "description": "The current balance of the account.",
            "example": 2694.39
          },
          "current_balance_date": {
            "type": "string",
            "description": "The date of the current balance.",
            "example": "2018-02-27"
          },
          "current_balance_in_base_currency": {
            "type": "number",
            "description": "The current balance of the account in the user's base currency.",
            "example": 4041.59
          },
          "current_balance_exchange_rate": {
            "type": "number",
            "description": "The exchange rate between the account's currency and the user's base currency, when different. If the currencies are the same, null is returned.",
            "example": 1.5
          },
          "safe_balance": {
            "type": "number",
            "description": "The current safe balance, if safe balance is activated on the account. If safe balance is not activated, then null is returned.",
            "example": 2694.39
          },
          "safe_balance_in_base_currency": {
            "type": "number",
            "description": "The current safe balance in the user's base currency, if safe balance is activated on the account. If safe balance is not activated, then null is returned.",
            "example": 4041.59
          }
        }
      },
      "TransactionAccount": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "example": 96027
          },
          "name": {
            "type": "string",
            "example": "Sample Credit"
          },
          "number": {
            "type": "string",
            "example": "ASBCRD44554"
          },
          "current_balance": {
            "type": "number",
            "example": 2694.39
          },
          "current_balance_date": {
            "type": "string",
            "example": "2015-07-03"
          },
          "current_balance_in_base_currency": {
            "type": "number",
            "description": "The current balance of the transaction account in the user's base currency.",
            "example": 4041.59
          },
          "current_balance_exchange_rate": {
            "type": "number",
            "description": "The exchange rate between the transaction account's currency and the user's base currency, when different. If the currencies are the same, null is returned.",
            "example": 1.5
          },
          "safe_balance": {
            "type": "number",
            "description": "The current safe balance, if safe balance is activated and available for the transaction account. If safe balance is not available, then null is returned.",
            "example": 2694.39
          },
          "safe_balance_in_base_currency": {
            "type": "number",
            "description": "The current safe balance in the user's base currency, if safe balance is activated and available for the transaction account. If safe balance is not available, then null is returned.",
            "example": 4041.59
          },
          "starting_balance": {
            "type": "number",
            "example": 3547.45
          },
          "starting_balance_date": {
            "type": "string",
            "example": "2015-03-15"
          },
          "created_at": {
            "type": "string",
            "example": "2015-03-17T02:42:10Z"
          },
          "updated_at": {
            "type": "string",
            "example": "2015-07-02T22:14:49Z"
          },
          "institution": {
            "$ref": "#/components/schemas/Institution"
          },
          "currency_code": {
            "type": "string",
            "description": "The currency that the account is in. This is determined by the account that the transaction account belongs to.",
            "example": "NZD"
          },
          "type": {
            "type": "string",
            "description": "The type of the transaction account.",
            "enum": [
              "bank",
              "credits",
              "cash",
              "stocks",
              "mortgage",
              "loans",
              "vehicle",
              "property",
              "insurance",
              "other_asset",
              "other_liability"
            ],
            "example": "bank"
          }
        }
      },
      "Scenario": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique identifier of the scenario.",
            "example": 42
          },
          "title": {
            "type": "string",
            "description": "The title of the scenario.",
            "example": "Wedding"
          },
          "description": {
            "type": "string",
            "description": "A short description of what the scenario is modelling."
          },
          "interest_rate": {
            "type": "number",
            "description": "The amount of interest to apply to the balance. Will apply periodically depending on what `interest_rate_repeat_id` is set to.",
            "example": 2.4
          },
          "interest_rate_repeat_id": {
            "type": "integer",
            "description": "A number representing how often the interest should be applied. 0 is used for no interest, 2 is weekly, 3 is fortnightly, 4 is monthly, 5 is yearly and 7 for quarterly.",
            "example": 4
          },
          "type": {
            "type": "string",
            "description": "The type of the scenario.",
            "enum": [
              "no-interest",
              "savings",
              "debt"
            ],
            "example": "no-interest"
          },
          "minimum-value": {
            "type": "number",
            "example": 4000
          },
          "maximum-value": {
            "type": "number",
            "example": 42
          },
          "achieve_date": {
            "type": "string",
            "description": "For goals, the date that they should be achieved by."
          },
          "starting_balance": {
            "type": "number",
            "description": "The starting balance of the scenario.",
            "example": 2450
          },
          "starting_balance_date": {
            "type": "string",
            "description": "The date of the starting balance.",
            "example": "2018-02-27"
          },
          "closing_balance": {
            "type": "number",
            "description": "The closing balance of the scenario.",
            "example": 5431.2
          },
          "closing_balance_date": {
            "type": "string",
            "description": "The date of the closing balance.",
            "example": "2018-02-27"
          },
          "current_balance": {
            "type": "number",
            "description": "The current balance of the scenario.",
            "example": 5431.2
          },
          "current_balance_date": {
            "type": "string",
            "description": "The date of the current balance.",
            "example": "2018-02-27"
          },
          "current_balance_in_base_currency": {
            "type": "number",
            "description": "The current balance of the scenario in the user's base currency.",
            "example": 8146.8
          },
          "current_balance_exchange_rate": {
            "type": "number",
            "description": "The exchange rate between the scenario's currency and the user's base currency, when different. If the currencies are the same, null is returned.",
            "example": 1.5
          },
          "safe_balance": {
            "type": "number",
            "description": "The current safe balance in the user's base currency, if safe balance is activated on the account associated with the scenario. If safe balance is not activated, then null is returned.",
            "example": 5431.2
          },
          "safe_balance_in_base_currency": {
            "type": "number",
            "description": "The current safe balance in the user's base currency, if safe balance is activated on the account associated with the scenario. If safe balance is not available, then null is returned.",
            "example": 8146.8
          },
          "created_at": {
            "type": "string",
            "description": "When the scenario was created.",
            "example": "2015-04-21T22:42:22Z"
          },
          "updated_at": {
            "type": "string",
            "description": "When the scenario was last updated.",
            "example": "2015-04-21T22:42:22Z"
          }
        }
      },
      "Error": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "description": "A message describing the error that occurred.",
            "example": "A message describing the error that occurred."
          }
        }
      }
    }
  },
  "paths": {
    "/accounts/{id}": {
      "get": {
        "summary": "Get account",
        "description": "Gets an account by its ID.",
        "tags": [
          "Accounts"
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Account"
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique identifier of the account.",
            "required": true,
            "schema": {
              "type": "integer"
            },
            "example": 42
          }
        ]
      }
    }
  },
  "security": [
    {
      "developerKey": []
    }
  ]
}
```