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

# Get account by ID

> Use this endpoint to retrieve the details of a specific Account by its identifier. Use this when you have an Account ID and need to confirm its name, Company membership, or timestamps.

###### Required fields:
- `accountId` - the Account identifier, passed as a path parameter (alphanumeric)

###### Optional parameters:
- `Snappy-Company-Id` header - optional company scoping

###### Please note:
- Returns `404` if no Account exists for the supplied `accountId`, or if it's not accessible to the calling API key.

#### Permissions
- Requires: `accounts:read`



## OpenAPI

````yaml get /v3/accounts/{accountId}
openapi: 3.0.3
info:
  title: Snappy Public API v3
  version: 3.0.0
  contact:
    name: Snappy Support
    email: info@snappy.com
  description: >-
    Welcome to the Snappy API reference documentation!

    You can use this API to integrate with Snappy and spread smiles to your
    employees/clients/customers and much more.

    So let's get started!
servers:
  - url: https://api.snappy.com/public-api
    description: Base API URL
  - url: https://mtls-api.snappy.com/public-api
    description: >-
      ## mTLS URL

      You can also use mTLS to enhance your API security. To get your specific
      certificates please contact our support.

      Once you configure the certificated correctly, you need to also update
      endpoints to use the following secure api base URL:
security: []
tags:
  - name: Products
    description: >-
      Use these endpoints to retrieve products and tags for building catalog and
      browse experiences in your UI.
  - name: Collections
    description: >-
      Use these endpoints to retrieve products within curated collections for
      marketplace and browse experiences.
  - name: Variants
    description: >-
      Use these endpoints to retrieve variants, variant pricing, and country
      availability for orderable product SKUs.
  - name: Billing Methods
    description: >-
      A **Billing Method** is the funding source attached to an **Account** -
      for example, a Purchase Order (PO), Invoice, Prepay deposit, or Credit
      Card. Use these endpoints to retrieve billing method details such as
      remaining balance, status, and expiration.
  - name: Accounts
    description: >-
      An **Account** is a sub-entity within a **Company**, used to organize
      campaigns and gift sends. Use these endpoints to list, retrieve, and
      create accounts.
  - name: API Keys
    description: >-
      Use these endpoints to manage API keys for programmatic access. Key
      management requires company owner privileges.
  - name: Orders
    description: >-
      Use these endpoints to place, retrieve, cancel, and validate orders and
      shipping addresses.
paths:
  /v3/accounts/{accountId}:
    get:
      tags:
        - Accounts
      summary: Get account by ID
      description: >-
        Use this endpoint to retrieve the details of a specific Account by its
        identifier. Use this when you have an Account ID and need to confirm its
        name, Company membership, or timestamps.


        ###### Required fields:

        - `accountId` - the Account identifier, passed as a path parameter
        (alphanumeric)


        ###### Optional parameters:

        - `Snappy-Company-Id` header - optional company scoping


        ###### Please note:

        - Returns `404` if no Account exists for the supplied `accountId`, or if
        it's not accessible to the calling API key.


        #### Permissions

        - Requires: `accounts:read`
      parameters:
        - schema:
            type: string
            pattern: ^[A-Za-z0-9]+$
            description: The id of the account.
            example: xyz12345
          required: true
          description: The id of the account.
          name: accountId
          in: path
        - schema:
            type: string
            description: Optional account identifier for swag validation/filtering.
            example: acc123456
          required: false
          description: Optional account identifier for swag validation/filtering.
          name: snappy-account-id
          in: header
        - schema:
            type: string
            description: Optional company identifier for swag validation/filtering.
            example: cmp123456
          required: false
          description: Optional company identifier for swag validation/filtering.
          name: snappy-company-id
          in: header
      responses:
        '200':
          description: Account details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SingleAccountResponseV3'
        '400':
          description: Bad Request - Invalid query parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV3'
        '404':
          description: Not Found - Account not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV3'
      security:
        - ApiKeyAuthentication: []
components:
  schemas:
    SingleAccountResponseV3:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AccountV3'
      required:
        - data
      description: JSON:API single-resource envelope for an account.
    ErrorResponseV3:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message.
          example: Product not found.
        errorCode:
          type: string
          description: Structured error code.
          example: 404_PROD_001
        errors:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
                example: Product with id 'q1w2e3r4t5' was not found
              path:
                type: string
                description: Dot-separated path to the field that caused the error.
                example: pathParameters.productId
              errorCode:
                type: string
                example: 404_PROD_001
            required:
              - message
              - path
          description: Optional field-level error details.
      required:
        - message
        - errorCode
      description: Standard v3 error envelope.
    AccountV3:
      type: object
      properties:
        id:
          type: string
          description: The id of the account.
          example: a12bcd34
        name:
          type: string
          description: The name of the account.
          example: Snappy
      description: Account object.
  securitySchemes:
    ApiKeyAuthentication:
      type: apiKey
      in: header
      name: X-Api-Key
      description: |-
        ## Company Level Authentication

        Include your API key in the `X-Api-Key` header for every request:
        ```
        X-Api-Key: YOUR_API_KEY
        ```

````