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

# Get the authenticated account and logged-in user

> > ⚠️ This endpoint is in [public preview](/preview/roadmap).

Returns the authenticated account along with details about the logged-in user that issued the calling token.

The `user` field is `null` when authenticated with a service token.



## OpenAPI

````yaml /preview/openapi.json get /preview/v2/me
openapi: 3.1.0
info:
  title: sfc-api
  description: >-
    Public preview API - subject to change. See
    https://docs.sfcompute.com/preview/roadmap for details.
  version: 0.1.0
servers:
  - url: https://api.sfcompute.com
security:
  - bearer_auth: []
tags:
  - name: Account
    description: The authenticated account and logged-in user.
  - name: Pools
    description: A bucket of owned compute balance over time.
  - name: Orders
    description: >-
      Place orders targeting a capacity to increase your reserved compute
      balance during some time period.
  - name: Instance Templates
    description: Reusable instance configuration.
  - name: Images
    description: Custom machine images for instances.
  - name: Roles
    description: TOML-based permission role definitions.
  - name: Grants
    description: Bind principals (users or tokens) to roles on a workspace.
  - name: Tokens
    description: Workspace-scoped API tokens.
  - name: Instances
    description: Spin up instances in a capacity to use your available compute.
  - name: Instance SKU Catalog
    description: Browse available instance SKU property definitions.
  - name: Procurements
    description: Market automations that maintain capacity by placing buy/sell orders.
  - name: Deployments
    description: Deployment automations that maintain a fleet of instances on a capacity.
  - name: Spot Deployments
    description: >-
      Spot deployment automations that buy capacity up to a maximum price and
      run instances on secured capacity.
  - name: Users
    description: Read-only access to users within the caller's organization.
  - name: Workspaces
    description: Resource containers scoped to an account.
  - name: Permissions
    description: Inspect what the caller is allowed to do.
  - name: Billing
    description: Billing profile, contacts, and auto top-up settings.
  - name: Orderbook
    description: >-
      Read-only orderbook visibility: bid/ask spread, depth of book, and
      historical fills, keyed on hardware requirements + delivery window.
  - name: Orders
    description: >-
      Estimate an order before placing it: filled price, fee, and operational
      notices.
paths:
  /preview/v2/me:
    get:
      tags:
        - Account
      summary: Get the authenticated account and logged-in user
      description: >-
        > ⚠️ This endpoint is in [public preview](/preview/roadmap).


        Returns the authenticated account along with details about the logged-in
        user that issued the calling token.


        The `user` field is `null` when authenticated with a service token.
      operationId: getMe
      responses:
        '200':
          description: Account and logged-in user information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeResponse'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '404':
          description: Account not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
components:
  schemas:
    MeResponse:
      type: object
      description: >-
        Response body for `GET /v2/me`: the authenticated account plus, when the
        caller is a human user, details about the logged-in user that issued the
        calling token.
      required:
        - object
        - account_id
        - created_at
      properties:
        object:
          type: string
          const: account
          default: account
          readOnly: true
        account_id:
          type: string
          description: The account identifier.
          example: acme-corp
        created_at:
          $ref: '#/components/schemas/UnixEpoch'
          description: When the account was created, as a Unix epoch timestamp in seconds.
        entity_type:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/EntityType'
              description: >-
                Whether the account is for personal use or a business, or `null`
                if it hasn't been set yet.
        user:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/UserResponse'
              description: >-
                The logged-in user that issued the calling token. `null` when
                authenticated with a service token, which acts on behalf of the
                account rather than an individual user.
    UnauthorizedError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - message
          properties:
            type:
              type: string
              const: authentication_error
              default: authentication_error
              readOnly: true
            message:
              type: string
              x-speakeasy-error-message: true
    NotFoundError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - message
          properties:
            type:
              type: string
              const: not_found
              default: not_found
              readOnly: true
            message:
              type: string
              x-speakeasy-error-message: true
    InternalServerError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - message
          properties:
            type:
              type: string
              const: api_error
              default: api_error
              readOnly: true
            message:
              type: string
              x-speakeasy-error-message: true
    UnixEpoch:
      type: integer
      format: int64
      description: Unix timestamp.
      example: 1738972800
    EntityType:
      type: string
      description: >-
        Whether the account is for personal use or a business. Captured once at
        onboarding and fixed thereafter (write-once).
      enum:
        - personal
        - business
    UserResponse:
      type: object
      required:
        - object
        - id
        - resource_path
        - created_at
      properties:
        object:
          type: string
          const: user
          default: user
          readOnly: true
        id:
          $ref: '#/components/schemas/UserId'
        resource_path:
          $ref: '#/components/schemas/userResourcePath_UserId'
        created_at:
          $ref: '#/components/schemas/UnixEpoch'
        email:
          type:
            - string
            - 'null'
          description: >-
            The member's primary email, or `null` if they have no recorded email
            identity.
        first_name:
          type:
            - string
            - 'null'
          description: The member's first name, or `null` if not recorded.
        last_name:
          type:
            - string
            - 'null'
          description: The member's last name, or `null` if not recorded.
    UserId:
      type: string
      examples:
        - my-resource-name
      maxLength: 255
      minLength: 1
      pattern: '[a-zA-Z0-9][a-zA-Z0-9._-]{0,254}'
    userResourcePath_UserId:
      type: string
      description: 'A resource path for a user resource. Format: sfc:user:<name>.'
      examples:
        - sfc:user:<name>
      pattern: sfc:user:[a-zA-Z0-9._-]+
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Create an API token using `sf tokens create` or at
        https://sfcompute.com/account/api-keys.

````