> For the complete documentation index, see [llms.txt](https://argos-ci.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://argos-ci.com/docs/api-reference/reference/users.md).

# Users

Retrieve information about the user authenticated by the current personal access token.

## Get an account

> Retrieve an account with its plan and current-period usage. Use it to watch screenshot consumption against the plan before it runs over.

````json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"tags":[{"name":"Users","description":"Retrieve information about the user authenticated by the current personal access token."}],"servers":[{"url":"https://api.argos-ci.com/v2","description":"API Endpoint"}],"security":[{"personalAccessToken":[]},{"oauth2":["profile"]}],"components":{"securitySchemes":{"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Personal Access Token","description":"Authenticate as a **user** with a personal access token.\n\nSend it as a bearer token in the `Authorization` header:\n\n```http\nAuthorization: Bearer <personal-access-token>\n```\n\nPersonal access tokens act on behalf of the user that created them\nand are required by endpoints that perform user actions, such as\nreviewing builds and posting comments."},"oauth2":{"type":"oauth2","description":"Authenticate as a **user** via an OAuth 2.1 access token obtained\nthrough the authorization-code (+ PKCE) flow. Used by the CLI and by\nMCP clients/agents. The token acts on behalf of the authorizing user,\nlimited to the granted scopes and organizations.","flows":{"authorizationCode":{"authorizationUrl":"https://app.argos-ci.com/oauth/authorize","tokenUrl":"https://app.argos-ci.com/oauth/token","refreshUrl":"https://app.argos-ci.com/oauth/token","scopes":{"profile":"Read your Argos profile and the list of teams you belong to.","projects:read":"Read your projects, builds, screenshots, diffs, tests, and analytics.","projects:write":"Create and configure projects and their settings.","builds:write":"Create and upload builds and screenshots.","reviews:write":"Approve, reject, or dismiss build reviews and ignore changes.","comments:read":"Read build comments and threads.","comments:write":"Post, edit, and delete comments, add reactions, and manage subscriptions.","media:read":"Read the images and videos uploaded to your teams.","media:write":"Upload images and videos, and delete the ones already uploaded.","account:admin":"Manage organization settings and members."}}}}},"schemas":{"AccountDetails":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string","minLength":1},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"type":"string","enum":["user","team"]},"plan":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"includedScreenshots":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["name","includedScreenshots"],"additionalProperties":false},{"type":"null"}],"description":"The account's plan, `null` when it has none."},"periodStartDate":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"Start of the current billing period."},"periodEndDate":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"End of the current billing period."},"currentPeriodScreenshots":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Screenshots used since the start of the current period."},"includedScreenshots":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Screenshots included in the plan for a period."},"consumptionRatio":{"type":"number","description":"Used screenshots over included screenshots. Above `1` the account is over its plan and pays for the extra."},"additionalScreenshotsCost":{"type":"number","description":"Cost accrued so far this period for screenshots beyond the plan, in the subscription's currency."},"defaultUserLevel":{"anyOf":[{"$ref":"#/components/schemas/TeamDefaultUserLevel"},{"type":"null"}],"description":"Role given to users joining through the invite link or a verified domain. `null` on a personal account."}},"required":["id","slug","name","type","plan","periodStartDate","periodEndDate","currentPeriodScreenshots","includedScreenshots","consumptionRatio","additionalScreenshotsCost","defaultUserLevel"],"additionalProperties":false,"description":"An account with its plan and current-period usage, to watch consumption against the plan."},"TeamDefaultUserLevel":{"type":"string","enum":["member","contributor"],"description":"Role given to users that join a team through its invite link or a verified email domain."},"Error":{"type":"object","properties":{"error":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["error"],"additionalProperties":false,"description":"Error response"}}},"paths":{"/accounts/{accountSlug}":{"get":{"operationId":"getAccount","summary":"Get an account","description":"Retrieve an account with its plan and current-period usage. Use it to watch screenshot consumption against the plan before it runs over.","tags":["Users"],"parameters":[{"in":"path","name":"accountSlug","schema":{"type":"string","minLength":1,"description":"Slug of the account to retrieve."},"required":true,"description":"Slug of the account to retrieve."}],"responses":{"200":{"description":"The account with its plan and usage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDetails"}}}},"400":{"description":"Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
````

## Get the current user

> Retrieve the user associated with the token used to authenticate the request, with the accounts (personal and teams) the token can access. Account slugs are the \`owner\` used in other API paths.

````json
{"openapi":"3.2.0","info":{"title":"Argos API","version":"2.0.0"},"tags":[{"name":"Users","description":"Retrieve information about the user authenticated by the current personal access token."}],"servers":[{"url":"https://api.argos-ci.com/v2","description":"API Endpoint"}],"security":[{"personalAccessToken":[]},{"oauth2":["profile"]}],"components":{"securitySchemes":{"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Personal Access Token","description":"Authenticate as a **user** with a personal access token.\n\nSend it as a bearer token in the `Authorization` header:\n\n```http\nAuthorization: Bearer <personal-access-token>\n```\n\nPersonal access tokens act on behalf of the user that created them\nand are required by endpoints that perform user actions, such as\nreviewing builds and posting comments."},"oauth2":{"type":"oauth2","description":"Authenticate as a **user** via an OAuth 2.1 access token obtained\nthrough the authorization-code (+ PKCE) flow. Used by the CLI and by\nMCP clients/agents. The token acts on behalf of the authorizing user,\nlimited to the granted scopes and organizations.","flows":{"authorizationCode":{"authorizationUrl":"https://app.argos-ci.com/oauth/authorize","tokenUrl":"https://app.argos-ci.com/oauth/token","refreshUrl":"https://app.argos-ci.com/oauth/token","scopes":{"profile":"Read your Argos profile and the list of teams you belong to.","projects:read":"Read your projects, builds, screenshots, diffs, tests, and analytics.","projects:write":"Create and configure projects and their settings.","builds:write":"Create and upload builds and screenshots.","reviews:write":"Approve, reject, or dismiss build reviews and ignore changes.","comments:read":"Read build comments and threads.","comments:write":"Post, edit, and delete comments, add reactions, and manage subscriptions.","media:read":"Read the images and videos uploaded to your teams.","media:write":"Upload images and videos, and delete the ones already uploaded.","account:admin":"Manage organization settings and members."}}}}},"schemas":{"Me":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/MeAccount"},"description":"The accounts this token can access: the personal account and the teams selected when the token was created or authorized."}},"required":["id","slug","name","accounts"],"additionalProperties":false,"description":"The authenticated user."},"MeAccount":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string","description":"Account slug, used as the `owner` in API paths."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"type":"string","enum":["user","team"]}},"required":["id","slug","name","type"],"additionalProperties":false,"description":"An account (personal or team) accessible to the token."},"Error":{"type":"object","properties":{"error":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["error"],"additionalProperties":false,"description":"Error response"}}},"paths":{"/me":{"get":{"operationId":"getMe","summary":"Get the current user","description":"Retrieve the user associated with the token used to authenticate the request, with the accounts (personal and teams) the token can access. Account slugs are the `owner` used in other API paths.","tags":["Users"],"responses":{"200":{"description":"The authenticated user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Me"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
````


---

# 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://argos-ci.com/docs/api-reference/reference/users.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.