> ## Documentation Index
> Fetch the complete documentation index at: https://docs.redbark.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve the account

> The account behind the API key: plan, entitlements, timezone and the key itself. Any key can call this to introspect its own scopes.



## OpenAPI

````yaml /openapi/v2.json get /me
openapi: 3.1.0
info:
  title: Redbark API
  version: 2026-10-01.wattle
  description: >-
    Everything a user can do in the dashboard, by API key. Send
    `Redbark-Version` on every request; see the conventions guide for ids,
    lists, errors and idempotency.
servers:
  - url: https://api.redbark.com/v2
security:
  - Bearer: []
    RedbarkVersion: []
tags:
  - name: Account
    description: The authenticated account, its plan and the key in use.
  - name: API keys
    description: Create, scope, rotate and revoke API keys.
  - name: Connections
    description: Linked banks and brokerages, and their lifecycle.
  - name: Consents
    description: Open Banking consents behind each connection.
  - name: Accounts
    description: Bank and brokerage accounts, live balances and details.
  - name: Transactions
    description: Transactions read live from the provider.
  - name: Holdings
    description: Brokerage positions.
  - name: Trades
    description: Brokerage trade history.
  - name: Categories
    description: The category taxonomy and provider categories.
  - name: Syncs
    description: Syncs from accounts to destinations.
  - name: Sync runs
    description: Individual sync executions.
  - name: Rules
    description: Rulesets and rules that transform transactions during a sync.
  - name: Destinations
    description: 'Where synced data lands: Sheets, Airtable, Notion, YNAB, webhooks.'
  - name: Link sessions
    description: Hosted flows that connect a bank or brokerage.
  - name: Destination links
    description: Hosted flows that authorise a destination.
  - name: Institutions
    description: Banks available to link.
  - name: Event destinations
    description: Endpoints that receive signed events.
  - name: Events
    description: What happened, and redelivery.
paths:
  /me:
    get:
      tags:
        - Account
      summary: Retrieve the account
      description: >-
        The account behind the API key: plan, entitlements, timezone and the key
        itself. Any key can call this to introspect its own scopes.
      operationId: get_me
      responses:
        '200':
          description: The account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Key lacks a scope, plan lacks the feature, or IP not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited; see Retry-After
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal error; quote request_id to support
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Account:
      type: object
      properties:
        id:
          type: string
          example: acc_5c9bQm2vT1xWz8nR4pLk7D
        object:
          type: string
          enum:
            - account
        plan:
          type: string
          example: developer
        status:
          type:
            - string
            - 'null'
        entitlements:
          type: object
          properties:
            api_access:
              type: boolean
            brokerage:
              type: boolean
          required:
            - api_access
            - brokerage
        limits:
          type: object
          properties:
            connections:
              type: integer
              description: '-1 means unlimited'
            accounts:
              type: integer
            syncs:
              type: integer
            destinations:
              type: integer
          required:
            - connections
            - accounts
            - syncs
            - destinations
        timezone:
          type: string
        api_version:
          type: string
        key:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            scopes:
              type: array
              items:
                $ref: '#/components/schemas/Scope'
            legacy:
              type: boolean
          required:
            - id
            - name
            - scopes
            - legacy
        livemode:
          type: boolean
      required:
        - id
        - object
        - plan
        - status
        - entitlements
        - limits
        - timezone
        - api_version
        - key
        - livemode
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - rate_limit_error
                - idempotency_error
                - upstream_error
                - api_error
            code:
              type: string
            message:
              type: string
            param:
              type:
                - string
                - 'null'
            doc_url:
              type: string
            request_id:
              type: string
          required:
            - type
            - code
            - message
            - param
            - doc_url
            - request_id
      required:
        - error
    Scope:
      type: string
      enum:
        - account:read
        - connections:read
        - connections:write
        - data:read
        - categories:read
        - categories:write
        - destinations:read
        - destinations:write
        - syncs:read
        - syncs:write
        - rules:read
        - rules:write
        - events:read
        - events:write
        - keys:write
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Authorization: Bearer rbk_live_...'
    RedbarkVersion:
      type: apiKey
      in: header
      name: Redbark-Version
      description: >-
        The API release your integration is built against, e.g.
        2026-10-01.wattle. Required on every request.

````