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

# Get event

Gets a particular event 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."
      }
    },
    "parameters": {
      "eventId": {
        "name": "id",
        "in": "path",
        "description": "The unique identifier of the event.",
        "required": true,
        "schema": {
          "type": "string"
        },
        "example": "42-1601942400"
      }
    },
    "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": {
      "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"
          }
        }
      },
      "Category": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique identifier of the category.",
            "example": 1438154
          },
          "title": {
            "type": "string",
            "description": "The title of the category.",
            "example": "Beer"
          },
          "colour": {
            "type": "string",
            "description": "The colour for the category.",
            "format": "CSS-style hex triplet",
            "example": "#00ff00"
          },
          "children": {
            "type": "array",
            "description": "The category's child categories.",
            "items": {
              "$ref": "#/components/schemas/Category"
            }
          },
          "parent_id": {
            "type": "integer",
            "description": "The unique identifier of the parent category of this category, or null if this category has no parent (i.e. is a top-level category)",
            "example": 42
          },
          "is_transfer": {
            "type": "boolean",
            "description": "Whether this category has been marked as a transfer category.",
            "example": false
          },
          "is_bill": {
            "type": "boolean",
            "description": "Whether the category is a bill category. A bill category is when budgeted amounts are normally spent at once, instead of spread across a budgeting period. This category will be included in the bill reminder email when set to true.",
            "example": true
          },
          "roll_up": {
            "type": "boolean",
            "description": "Whether the category's budget is rolled up into its parent category, if a parent category is present.",
            "example": false
          },
          "refund_behaviour": {
            "type": "string",
            "nullable": true,
            "description": "How the category's refunds or deductions should be reported on.",
            "enum": [
              "debits_are_deductions",
              "credits_are_refunds",
              null
            ],
            "example": "credits_are_refunds"
          },
          "created_at": {
            "type": "string",
            "description": "When the category was created.",
            "format": "ISO 8601 timestamp",
            "example": "2015-08-16T02:17:02Z"
          },
          "updated_at": {
            "type": "string",
            "description": "When the category was last updated.",
            "format": "ISO 8601 timestamp",
            "example": "2015-08-16T02:17:02Z"
          }
        }
      },
      "Event": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier of the event.",
            "example": "42-1601942400"
          },
          "category": {
            "$ref": "#/components/schemas/Category"
          },
          "scenario": {
            "$ref": "#/components/schemas/Scenario"
          },
          "amount": {
            "type": "number",
            "description": "The amount of the event.",
            "example": 250.5
          },
          "amount_in_base_currency": {
            "type": "number",
            "description": "The amount of the event in the user's base currency.",
            "example": 375.75
          },
          "currency_code": {
            "type": "string",
            "description": "The currency code of the event.",
            "example": "nzd"
          },
          "date": {
            "type": "string",
            "description": "The date of the event.",
            "example": "2020-10-27"
          },
          "colour": {
            "type": "string",
            "description": "The CSS hex-style colour of the event.",
            "example": "#F63737"
          },
          "note": {
            "type": "string",
            "description": "The note of the event.",
            "example": "Buy more beer every Friday from the local brewery."
          },
          "repeat_type": {
            "type": "string",
            "description": "The repeat type of the event.",
            "enum": [
              "once",
              "daily",
              "weekly",
              "fortnightly",
              "monthly",
              "yearly",
              "each weekday"
            ],
            "example": "weekly"
          },
          "repeat_interval": {
            "type": "integer",
            "description": "The repeat interval of how often the event takes place.",
            "example": 1
          },
          "series_id": {
            "type": "integer",
            "description": "The unique identifier of the series that the event belongs to.",
            "example": 42
          },
          "series_start_id": {
            "type": "string",
            "description": "The unique identifier of the series followed by the series's start date.",
            "example": "42-1593993600"
          },
          "infinite_series": {
            "type": "boolean",
            "description": "Whether the event repeats and does not have an end date.",
            "example": true
          }
        }
      },
      "Error": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "description": "A message describing the error that occurred.",
            "example": "A message describing the error that occurred."
          }
        }
      }
    }
  },
  "paths": {
    "/events/{id}": {
      "get": {
        "summary": "Get event",
        "description": "Gets a particular event by its ID.",
        "tags": [
          "Events"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/eventId"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Event"
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          }
        }
      }
    }
  },
  "security": [
    {
      "developerKey": []
    }
  ]
}
```