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

# Get account

> Retrieve your account details and pricing.



## OpenAPI

````yaml openapi.json GET /client
openapi: 3.1.0
info:
  title: Karta Public API
  version: 1.0.0-draft
  description: >-
    Karta API reference for accounts, agents, calls, campaigns, WebSocket
    sessions, and billing.
servers:
  - url: https://api.getkarta.ai/public/v1
    description: Production
security:
  - BearerApiKey: []
tags:
  - name: Account
  - name: Agents
  - name: Calls
  - name: Phone numbers
  - name: Campaigns
  - name: Realtime
  - name: Billing
  - name: Webhooks
    description: Outgoing call events delivered to your server.
paths:
  /client:
    get:
      tags:
        - Account
      summary: Get account
      description: Retrieve your account details and pricing.
      operationId: getAccount
      parameters:
        - name: X-Request-ID
          in: header
          required: false
          description: Optional request-tracing identifier.
          schema:
            type: string
          example: example-request-001
      responses:
        '200':
          description: Successful response.
          headers:
            X-Request-ID:
              description: Request identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
              example:
                client_code: GBL001
                name: Acme Corp
                pricing:
                  - feature: voice
                    credit_per_interval: 8
                    call_type: sip
                    direction: inbound
                    rounding: round
                    interval_seconds: 60
                    minimum_seconds: 1
        '400':
          description: Invalid request or account configuration.
          headers:
            X-Request-ID:
              description: Request identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/AuthProblem'
                    title: Authentication or account configuration error
                  - $ref: '#/components/schemas/RequestProcessingError'
                    title: Request processing error
              examples:
                configuration:
                  summary: Account configuration error
                  value:
                    type: https://httpstatus.es/400
                    title: Missing Data Residency
                    status: 400
                    detail: Client dataResidency not set. Please contact support.
                    instance: example-request-001
                    code: missing_data_residency
                request:
                  summary: Request parsing error (illustrative message)
                  value:
                    message: Unexpected end of JSON input
        '401':
          description: Authentication failed.
          headers:
            X-Request-ID:
              description: Request identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/AuthProblem'
                    title: Authentication or account configuration error
                  - $ref: '#/components/schemas/MissingAccountContextError'
                    title: Missing account context
              examples:
                authentication:
                  summary: Missing API key
                  value:
                    type: https://httpstatus.es/401
                    title: Invalid API Key
                    status: 401
                    detail: API key is required
                    instance: example-request-001
                    code: invalid_api_key
                MissingAccountContextError:
                  summary: Missing account context
                  value:
                    error: UNAUTHORIZED
        '403':
          description: API key not permitted for this operation.
          headers:
            X-Request-ID:
              description: Request identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthProblem'
                title: Authentication or account configuration error
              examples:
                authentication:
                  summary: Wrong key type
                  value:
                    type: https://httpstatus.es/403
                    title: Wrong API Key Type
                    status: 403
                    detail: Widget API keys may only be used on /widget paths
                    instance: example-request-001
                    code: wrong_key_audience
        '404':
          description: The account associated with the key was not found or is archived.
          headers:
            X-Request-ID:
              description: Request identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountNotFoundError'
                title: Account not found
              example:
                error: INVALID_REQUEST
                message: Client not found
        '500':
          description: Internal server error.
          headers:
            X-Request-ID:
              description: Request identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/AuthProblem'
                    title: Authentication or account configuration error
                  - $ref: '#/components/schemas/RequestProcessingError'
                    title: Request processing error
                  - $ref: '#/components/schemas/AccountLookupError'
                    title: Account lookup failure
              examples:
                authentication:
                  summary: Authentication failure
                  value:
                    type: https://httpstatus.es/500
                    title: Internal Server Error
                    status: 500
                    detail: Authentication failed
                    instance: example-request-001
                    code: internal_error
                request:
                  summary: Request processing failure
                  value:
                    message: Internal Server Error
                AccountLookupError:
                  summary: Account lookup failure
                  value:
                    error: CLIENT_FETCH_FAILED
components:
  schemas:
    Account:
      type: object
      properties:
        client_code:
          type: string
          description: Account code for the API key.
          example: GBL001
        name:
          type: string
        pricing:
          type: array
          items:
            $ref: '#/components/schemas/PricingRule'
          description: Your account’s pricing rules.
    AuthProblem:
      type: object
      properties:
        type:
          type: string
          description: Identifier for this error category.
        title:
          type: string
          description: Short summary of the error.
        status:
          type: integer
          description: HTTP status code for this response.
        detail:
          type: string
          description: Explanation of the failure.
        instance:
          type: string
          description: Request identifier.
        code:
          type: string
          description: Machine-readable error code.
      title: Authentication or account configuration error
    RequestProcessingError:
      title: Request processing error
      type: object
      properties:
        message:
          type: string
          description: Description of the request-processing failure.
        errors:
          type: array
          items:
            additionalProperties: true
            type: object
          description: Additional error details, when supplied.
    MissingAccountContextError:
      title: Missing account context
      type: object
      properties:
        error:
          type: string
          enum:
            - UNAUTHORIZED
    AccountNotFoundError:
      title: Account not found
      type: object
      properties:
        error:
          type: string
          enum:
            - INVALID_REQUEST
          description: Machine-readable account error code.
        message:
          type: string
          description: Description of the account lookup failure.
    AccountLookupError:
      title: Account lookup failure
      type: object
      properties:
        error:
          type: string
          enum:
            - CLIENT_FETCH_FAILED
          description: Machine-readable account error code.
    PricingRule:
      type: object
      properties:
        feature:
          type: string
          description: Feature this pricing rule applies to.
        credit_per_interval:
          type: number
          description: Credits charged per configured interval or billing unit.
        call_type:
          type: string
          enum:
            - sip
            - web
        direction:
          type: string
          enum:
            - inbound
            - outbound
        rounding:
          type: string
          description: Rounding policy configured for this rule.
        interval_seconds:
          type: number
          description: Seconds per interval, when applicable.
        minimum_seconds:
          type: number
          description: Minimum billable duration, when applicable.
        billing_pulse_size:
          type: number
          description: Billing pulse size for applicable non-second units.
  securitySchemes:
    BearerApiKey:
      type: http
      scheme: bearer
      description: 'API key in the format: Bearer YOUR_KARTA_API_KEY.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.