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

# Obter conta

> Retorna a conta dona da chave, as permissões da chave e os limites de uso. Útil para testar a chave.



## OpenAPI

````yaml https://api.ziala.com.br/v1/openapi.json get /v1/me
openapi: 3.0.0
info:
  title: API de dados da Ziala
  description: >-
    Leitura dos dados da sua conta (contatos, campos, conversas com origem de
    anúncio, mudanças de etapa e exclusões) para painéis e plataformas de dados.
  version: '1'
  contact:
    name: Suporte Ziala
    url: https://ziala.com.br
    email: contato@ziala.com.br
servers:
  - url: https://api.ziala.com.br
security: []
tags:
  - name: Conta
    description: A conta e os limites da chave.
  - name: Contatos
    description: Contatos e os valores dos campos personalizados.
  - name: Conversas
    description: Conversas, com origem e métricas.
  - name: Funis
    description: Etapas dos funis e o histórico de mudanças de etapa.
  - name: Campos
    description: Definições dos campos personalizados.
  - name: Exclusões
    description: Registros apagados, para replicar a exclusão.
paths:
  /v1/me:
    get:
      tags:
        - Conta
      summary: Obter conta
      description: >-
        Retorna a conta dona da chave, as permissões da chave e os limites de
        uso. Útil para testar a chave.
      operationId: getAccount
      parameters: []
      responses:
        '200':
          headers:
            RateLimit-Limit:
              description: Requisições permitidas por minuto para a chave.
              schema:
                type: integer
            RateLimit-Remaining:
              description: Requisições restantes no minuto.
              schema:
                type: integer
            RateLimit-Reset:
              description: Segundos até o minuto reiniciar.
              schema:
                type: integer
          description: Conta da chave.
          content:
            application/json:
              schema:
                type: object
                required:
                  - account_name
                  - scopes
                  - limits
                properties:
                  account_name:
                    type: string
                    nullable: true
                    example: Exemplo Ltda
                    description: Nome da conta dona da chave.
                  scopes:
                    type: array
                    items:
                      type: string
                    example:
                      - data:read
                    description: 'Permissões da chave. Hoje: `data:read`.'
                  limits:
                    type: object
                    description: Limites de uso da conta.
                    required:
                      - per_minute
                      - per_day
                    properties:
                      per_minute:
                        type: integer
                        example: 60
                        description: Requisições por minuto, por chave.
                      per_day:
                        type: integer
                        example: 10000
                        description: Requisições por dia, somando todas as chaves.
        '401':
          description: Chave ausente, inválida ou revogada.
          content:
            application/problem+json:
              schema:
                type: object
                required:
                  - type
                  - title
                  - status
                  - detail
                  - request_id
                properties:
                  type:
                    type: string
                    example: about:blank
                    description: Sempre `about:blank`.
                  title:
                    type: string
                    example: Requisição inválida
                    description: Resumo do erro, fixo por status.
                  status:
                    type: integer
                    example: 400
                    description: Status HTTP.
                  detail:
                    type: string
                    example: limit deve ser um número inteiro de 1 a 200.
                    description: Explicação desta ocorrência.
                  request_id:
                    type: string
                    example: req-3f2a
                    description: Identificador da requisição, para o suporte.
        '403':
          description: API de dados desligada na conta, ou plano sem acesso.
          content:
            application/problem+json:
              schema:
                type: object
                required:
                  - type
                  - title
                  - status
                  - detail
                  - request_id
                properties:
                  type:
                    type: string
                    example: about:blank
                    description: Sempre `about:blank`.
                  title:
                    type: string
                    example: Requisição inválida
                    description: Resumo do erro, fixo por status.
                  status:
                    type: integer
                    example: 400
                    description: Status HTTP.
                  detail:
                    type: string
                    example: limit deve ser um número inteiro de 1 a 200.
                    description: Explicação desta ocorrência.
                  request_id:
                    type: string
                    example: req-3f2a
                    description: Identificador da requisição, para o suporte.
        '429':
          description: >-
            Limite de requisições atingido (por minuto, por dia ou simultâneas).
            Aguarde o `Retry-After`.
          headers:
            Retry-After:
              description: Segundos a aguardar antes de repetir a requisição.
              schema:
                type: integer
            RateLimit-Limit:
              description: Requisições permitidas por minuto para a chave.
              schema:
                type: integer
            RateLimit-Remaining:
              description: Requisições restantes no minuto.
              schema:
                type: integer
            RateLimit-Reset:
              description: Segundos até o minuto reiniciar.
              schema:
                type: integer
          content:
            application/problem+json:
              schema:
                type: object
                required:
                  - type
                  - title
                  - status
                  - detail
                  - request_id
                properties:
                  type:
                    type: string
                    example: about:blank
                    description: Sempre `about:blank`.
                  title:
                    type: string
                    example: Requisição inválida
                    description: Resumo do erro, fixo por status.
                  status:
                    type: integer
                    example: 400
                    description: Status HTTP.
                  detail:
                    type: string
                    example: limit deve ser um número inteiro de 1 a 200.
                    description: Explicação desta ocorrência.
                  request_id:
                    type: string
                    example: req-3f2a
                    description: Identificador da requisição, para o suporte.
        '500':
          description: Erro inesperado. Repita com espera crescente.
          content:
            application/problem+json:
              schema:
                type: object
                required:
                  - type
                  - title
                  - status
                  - detail
                  - request_id
                properties:
                  type:
                    type: string
                    example: about:blank
                    description: Sempre `about:blank`.
                  title:
                    type: string
                    example: Requisição inválida
                    description: Resumo do erro, fixo por status.
                  status:
                    type: integer
                    example: 400
                    description: Status HTTP.
                  detail:
                    type: string
                    example: limit deve ser um número inteiro de 1 a 200.
                    description: Explicação desta ocorrência.
                  request_id:
                    type: string
                    example: req-3f2a
                    description: Identificador da requisição, para o suporte.
        '503':
          description: Serviço temporariamente indisponível. Aguarde o `Retry-After`.
          headers:
            Retry-After:
              description: Segundos a aguardar antes de repetir a requisição.
              schema:
                type: integer
            RateLimit-Limit:
              description: Requisições permitidas por minuto para a chave.
              schema:
                type: integer
            RateLimit-Remaining:
              description: Requisições restantes no minuto.
              schema:
                type: integer
            RateLimit-Reset:
              description: Segundos até o minuto reiniciar.
              schema:
                type: integer
          content:
            application/problem+json:
              schema:
                type: object
                required:
                  - type
                  - title
                  - status
                  - detail
                  - request_id
                properties:
                  type:
                    type: string
                    example: about:blank
                    description: Sempre `about:blank`.
                  title:
                    type: string
                    example: Requisição inválida
                    description: Resumo do erro, fixo por status.
                  status:
                    type: integer
                    example: 400
                    description: Status HTTP.
                  detail:
                    type: string
                    example: limit deve ser um número inteiro de 1 a 200.
                    description: Explicação desta ocorrência.
                  request_id:
                    type: string
                    example: req-3f2a
                    description: Identificador da requisição, para o suporte.
      security:
        - bearer: []
components:
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: zk_live_…
      type: http
      description: Chave da API da conta, no formato `zk_live_…`.

````

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