> ## Documentation Index > Fetch the complete documentation index at: https://pigeonpost-developer.27communication.com/llms.txt > Use this file to discover all available pages before exploring further. # Get an account > Returns one account: its address, provider, status, metadata and connection settings. Passwords and tokens are never returned. ## OpenAPI ````yaml /api-reference/openapi.yaml get /accounts/{account_id} openapi: 3.1.0 info: title: PigeonPost API version: 1.0.0 description: > Connect your users' mailboxes (Gmail with an app password, and any IMAP/SMTP provider), read, send and manage their email, and receive webhooks when something changes. The API follows Unipile's v2 conventions (ids, lists, events); its own version is v1. **Authentication:** every request needs your access token in the `X-API-KEY` header. Create tokens in your dashboard under **API keys**, or with `POST /api/v1/api-keys`. **Base URL:** `https://{your DSN}/api/v1`. Your DSN is shown in your dashboard. **Ids** carry their type: `acc_…` (account), `email_…`, `att_…` (attachment), `fld_…` (folder), `drf_…` (draft), `we_…` (webhook endpoint), `evt_…` (event), `pk_…` (API key). **Lists** are `{ "object": "", "data": [...], "has_more": true|false }`. Accounts, webhook endpoints, conversations and API keys page with `offset` and `limit`. Emails, drafts and contacts page with a `cursor`: pass the `cursor` of a response back to get the next page. **Errors** always have the same JSON shape: `status`, `type`, `title`, `detail`. servers: - url: https://{dsn}/api/v1 description: Your workspace's DSN, from your dashboard variables: dsn: default: mail-api.example.com description: Your DSN, for example mail-api.example.com security: - apiKey: [] tags: - name: Auth description: Connect a mailbox from your app (IMAP/SMTP). - name: Accounts description: The mailboxes connected to your workspace. - name: Emails description: Read, search, send, change and delete emails. - name: Attachments description: Download the files attached to an email. - name: Drafts description: Drafts saved in the user's mailbox. - name: Folders description: Folders (Gmail labels appear as folders over IMAP). - name: Contacts description: The people an account has emailed with. - name: Webhooks description: Get notified when something happens in a mailbox. - name: API keys description: Access tokens for this API. paths: /accounts/{account_id}: parameters: - $ref: '#/components/parameters/account_id' get: tags: - Accounts summary: Get an account description: > Returns one account: its address, provider, status, metadata and connection settings. Passwords and tokens are never returned. operationId: getAccount responses: '200': description: The account. content: application/json: schema: $ref: '#/components/schemas/Account' example: $ref: '#/components/examples/ImapAccount/value' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' components: parameters: account_id: name: account_id in: path required: true description: The account's `acc_…` id. schema: type: string example: acc_ba1fa6938d8548298e8ce62e4b4b4e99 schemas: Account: type: object properties: object: type: string const: Account id: type: string description: '`acc_…`' user_id: type: string description: The mailbox's email address. name: type: string provider: $ref: '#/components/schemas/Provider' status: $ref: '#/components/schemas/AccountStatus' status_detail: type: string description: The last error message if any.: null is_locked: type: boolean description: 'Paused from the dashboard: not syncing.' initial_sync: $ref: '#/components/schemas/InitialSync' metadata: type: object additionalProperties: type: string description: Your own key-value data. connection_params: type: object description: Connection settings, never passwords. created_at: type: string format: date-time last_synced_at: type: - string - 'null' format: date-time Provider: type: string enum: - imap description: >- `imap`: Gmail, Google Workspace and every other provider through IMAP/SMTP. AccountStatus: type: string enum: - running - errored - disconnected description: > - `running`: connected and syncing. - `errored`: syncing keeps failing (server down, network); the engine retries by itself. - `disconnected`: the provider rejected the password or token (reconnect it), or the account is paused in the dashboard (`is_locked: true`). InitialSync: type: object description: >- Only on accounts connected with `initial_sync_enable: true`: the import of the mail already in the mailbox. properties: status: type: string enum: - pending - running - completed - failed description: >- `pending`: not started yet; `running`: importing; `completed`: done; `failed`: gave up after 5 failed tries (new mail still syncs). started_at: type: - string - 'null' format: date-time completed_at: type: - string - 'null' format: date-time description: When it completed or failed. days: type: integer minimum: 1 maximum: 30 description: How many days back were imported. imported: type: - integer - 'null' description: Emails imported (set when it completes or fails). Error: type: object properties: status: type: integer type: type: string enum: - errors/invalid_parameters - errors/unauthorized - errors/invalid_credentials - errors/not_found - errors/already_exists - errors/provider_rejected - errors/provider_error - errors/unexpected_error title: type: string detail: type: string responses: Unauthorized: description: The `X-API-KEY` header is missing, wrong or revoked. content: application/json: schema: $ref: '#/components/schemas/Error' example: status: 401 type: errors/unauthorized title: Unauthorized detail: missing or invalid API key NotFound: description: Nothing with this id (a malformed or wrong-type id is also not found). content: application/json: schema: $ref: '#/components/schemas/Error' example: status: 404 type: errors/not_found title: Not found detail: email email_94a0d77db739407e932c3b97fef44aac not found securitySchemes: apiKey: type: apiKey in: header name: X-API-KEY description: Your access token, from your dashboard under **API keys**. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.