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

# Retrieve the account

> Returns the organization, plan, available credits, limits, and the calling key's monthly credit budget. Every valid key may call it, so an agent can check it can afford a request before making it.



## OpenAPI

````yaml /api/openapi.yaml get /account
openapi: 3.1.0
info:
  title: LocalAds API
  version: 1.0.0
  description: Public API for LocalAds customer integrations.
servers:
  - url: https://makelocalads.com/api/v1
security:
  - apiKey: []
tags:
  - name: Account
    description: Your organization, balance and prices.
  - name: Set up
    description: Brands, products, audiences and image uploads.
  - name: Ad campaigns
    description: Campaigns and their creatives.
  - name: Listing images
    description: Amazon listing image ideas and renders.
  - name: Photoshoots
    description: Photoshoots, templates and moodboards.
  - name: ChatGPT ads
    description: ChatGPT ad groups and ads.
  - name: UGC videos
    description: Recipes, concepts, voices and videos.
  - name: Creatives
    description: The cross-type list of finished images and videos.
paths:
  /account:
    get:
      tags:
        - Account
      summary: Retrieve the account
      description: >-
        Returns the organization, plan, available credits, limits, and the
        calling key's monthly credit budget. Every valid key may call it, so an
        agent can check it can afford a request before making it.
      operationId: getAccount
      responses:
        '200':
          description: Account found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    Account:
      type: object
      required:
        - organization
        - plan
        - credits
        - limits
        - api_key
      properties:
        organization:
          type: object
          required:
            - name
          properties:
            name:
              type: string
        plan:
          type: object
          required:
            - slug
            - label
          properties:
            slug:
              type: string
              example: pro
            label:
              type: string
              example: Pro
        credits:
          type: object
          required:
            - available
          properties:
            available:
              type: integer
        limits:
          type: object
          required:
            - brands
            - products
          description: Null means unlimited.
          properties:
            brands:
              type:
                - integer
                - 'null'
            products:
              type:
                - integer
                - 'null'
        api_key:
          type: object
          required:
            - id
            - name
            - monthly_credit_cap
            - credits_used_this_month
            - credits_remaining_this_month
          properties:
            id:
              type: string
            name:
              type: string
            monthly_credit_cap:
              type:
                - integer
                - 'null'
            credits_used_this_month:
              type: integer
            credits_remaining_this_month:
              type:
                - integer
                - 'null'
              description: Null when the key has no monthly cap.
    Problem:
      type: object
      required:
        - type
        - title
        - status
        - detail
        - code
        - request_id
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        code:
          type: string
        request_id:
          type: string
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Forbidden:
      description: >-
        The API key lacks the required permission (`insufficient_permission`),
        the organization's plan does not include API access
        (`plan_upgrade_required`; Pro and Enterprise only), or the organization
        is suspended (`org_suspended`).
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    RateLimited:
      description: API key rate limit exceeded.
      headers:
        Retry-After:
          schema:
            type: integer
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: lads_...

````