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

# Saldo de Pontos

> Consultar saldo de pontos de um cliente

# Saldo de Pontos

Retorna o saldo atual de pontos de um cliente dentro da empresa autenticada.

## Path Parameters

<ParamField path="client_id" type="string" required>
  ID do cliente (UUID)
</ParamField>

## Request

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://api.indiqai.com/api/v1/public/points/550e8400-e29b-41d4-a716-446655440000" \
    -H "X-API-Key: indiqai_sua_chave_aqui"
  ```

  ```typescript JavaScript theme={null}
  const clientId = '550e8400-e29b-41d4-a716-446655440000';

  const response = await fetch(
    `https://api.indiqai.com/api/v1/public/points/${clientId}`,
    {
      headers: { 'X-API-Key': 'indiqai_sua_chave_aqui' }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import httpx

  client_id = '550e8400-e29b-41d4-a716-446655440000'

  response = httpx.get(
      f'https://api.indiqai.com/api/v1/public/points/{client_id}',
      headers={'X-API-Key': 'indiqai_sua_chave_aqui'}
  )

  data = response.json()
  ```
</CodeGroup>

## Response

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "client_id": "550e8400-e29b-41d4-a716-446655440000",
    "balance": 1250,
    "empresa_id": "660f9500-f39c-52e5-b827-557766551111"
  }
  ```

  ```json 404 Not Found theme={null}
  {
    "detail": "Cliente não encontrado"
  }
  ```
</ResponseExample>

## Campos da Resposta

<ResponseField name="client_id" type="string">
  ID do cliente
</ResponseField>

<ResponseField name="balance" type="integer">
  Saldo atual de pontos disponíveis
</ResponseField>

<ResponseField name="empresa_id" type="string">
  Empresa dona da carteira consultada
</ResponseField>


## OpenAPI

````yaml GET /api/v1/public/points/{client_id}
openapi: 3.1.0
info:
  contact:
    email: support@indiqai.com
    name: IndiqAI Support
    url: https://indiqai.com/
  description: Especificação OpenAPI da API Pública IndiqAI.
  license:
    name: Proprietary
    url: https://indiqai.com/license
  title: IndiqAI API Pública
  version: 1.5.0
servers:
  - description: Produção
    url: https://api.indiqai.com
security: []
paths:
  /api/v1/public/points/{client_id}:
    get:
      tags:
        - API Pública
      summary: Consultar saldo de pontos
      description: Retorna saldo de pontos do cliente na empresa.
      operationId: get_points_api_v1_public_points__client_id__get
      parameters:
        - in: path
          name: client_id
          required: true
          schema:
            title: Client Id
            type: string
        - description: Chave de API
          in: header
          name: X-API-Key
          required: true
          schema:
            description: Chave de API
            title: X-Api-Key
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicPointsResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    PublicPointsResponse:
      description: Saldo de pontos de um cliente.
      properties:
        balance:
          title: Balance
          type: integer
        client_id:
          title: Client Id
          type: string
        empresa_id:
          title: Empresa Id
          type: string
      required:
        - client_id
        - balance
        - empresa_id
      title: PublicPointsResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object

````