> For the complete documentation index, see [llms.txt](https://docs-v2.bulkmail.shop/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs-v2.bulkmail.shop/account/get-your-dashboard.md).

# Get your dashboard

Account, totals, and your 5 most recent orders and transactions.

```json
{"openapi":"3.1.0","info":{"title":"BulkMail API","version":"2.0"},"tags":[{"name":"Account","description":"Your profile, password and dashboard.\n\n| Method | Endpoint | What it does |\n|---|---|---|\n| `GET` | `/user/profile` | Get your profile |\n| `PUT` | `/user/profile` | Update your profile |\n| `POST` | `/user/password` | Change your password |\n| `GET` | `/user/dashboard` | Get your dashboard |\n| `DELETE` | `/user/account` | Delete your account |\n\n**Authentication:** API key. Send your key in the `X-API-Key` header."}],"servers":[{"url":"https://bulkmail.shop/api/v2","description":"Production"}],"security":[{"ApiKeyAuth":[]},{"ApiKeyQuery":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Your API key (sk_live_…)."},"ApiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Same key as a query parameter. Prefer the header."}},"responses":{"Unauthorized":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","const":false},"error":{"type":"string","description":"What went wrong."},"errors":{"type":"object","description":"Details: field name to messages for validation errors; code and allowed_quantities for pack-size errors."}}}}},"paths":{"/user/dashboard":{"get":{"tags":["Account"],"summary":"Get your dashboard","operationId":"getUserDashboard","description":"Account, totals, and your 5 most recent orders and transactions.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"true when the request worked, false on any error."},"data":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"email":{"type":"string"},"balance":{"type":"number","description":"Balance in USD."},"status":{"type":"string","description":"Current status."},"created_at":{"type":"string","format":"date-time","description":"ISO 8601, UTC."}},"required":["id","name","email","balance","status","created_at"]},"stats":{"type":"object","properties":{"total_orders":{"type":"integer"},"total_spent":{"type":"number"},"purchased_items":{"type":"integer"}},"required":["total_orders","total_spent","purchased_items"]},"recent_orders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"product_id":{"type":"integer","description":"Product id (see GET /products)."},"quantity":{"type":"integer","description":"Units to buy."},"total_amount":{"type":"number","description":"Amount charged, USD."},"status":{"type":"string","description":"Current status."},"created_at":{"type":"string","format":"date-time","description":"ISO 8601, UTC."}},"required":["id","product_id","quantity","total_amount","status","created_at"]}},"recent_transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string","description":"Transaction type. credit = admin top-up or referral reward."},"amount":{"type":"number","description":"USD, always positive."},"direction":{"type":"string","description":"in (money added) or out (money spent)."},"signed_amount":{"type":"number","description":"amount with a sign: positive for in, negative for out."},"balance_after":{"type":"number","description":"Your balance after this transaction, USD."},"created_at":{"type":"string","format":"date-time","description":"ISO 8601, UTC."}},"required":["id","type","amount","direction","signed_amount","balance_after","created_at"]}}},"required":["user","stats","recent_orders","recent_transactions"],"description":"The account line."}},"required":["success","data"]}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs-v2.bulkmail.shop/account/get-your-dashboard.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.