> For the complete documentation index, see [llms.txt](https://docs.podigee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.podigee.com/documentation/connect-and-administer/integrations/rest-api/rest-api-account.md).

# REST API account

The me endpoint of the REST API v1, read the account, its plan, and change report and locale settings.

Use this reference when your integration needs to know which account a credential belongs to, or which plan the account has. Use it also when the integration changes the report subscription or the locale of the account. Paths are relative to `https://app.podigee.com/api/v1`.

## Endpoints

| Method | Path  | Purpose                                | Notable parameters                | Response notes                          |
| ------ | ----- | -------------------------------------- | --------------------------------- | --------------------------------------- |
| `GET`  | `/me` | Read the account behind the credential | none                              | Returns the fields below, among others. |
| `PUT`  | `/me` | Change account settings                | `subscribed_to_reports`, `locale` |                                         |

## Response fields

| Field                   | Meaning                                                 |
| ----------------------- | ------------------------------------------------------- |
| `id`                    | Account id                                              |
| `email`                 | Account email address                                   |
| `subscribed_to_reports` | Whether the account receives analytics reports by email |
| `locale`                | Language of the account                                 |
| `country`               | Country of the account                                  |
| `plan`                  | The plan with its `kind` and `name`                     |
| `packages`              | Package identifiers of the plan                         |
| `trial_expired`         | Whether the trial of the account has expired            |

The `plan` object contains only `kind` and `name`. Prices and allowances are not part of the response.

## Related pages

* The agent path for the same check: [Check the connected account and granted access](/documentation/start-here/ai-agents/check-your-account-and-readiness/check-the-connected-account-and-granted-access.md)
* [REST API authentication and errors](/documentation/connect-and-administer/integrations/rest-api/rest-api-authentication-and-errors.md)


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.podigee.com/documentation/connect-and-administer/integrations/rest-api/rest-api-account.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.