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

# Contar contatos

> Retorne a quantidade de contatos correspondente a uma pesquisa sem trazer os registros.

**URL completa:** `https://services.leadconnectorhq.com/contacts/search/count`

> [!NOTE]
>
> **Token e permissões:** na Salez, acesse **Configurações > Integrações Privadas** para gerar ou gerenciar o token, conforme seu nível de acesso. Esta operação exige o escopo `contacts.readonly`. Envie `Authorization: Bearer <token>` e `Version: v3`. O valor `count` poderá ser `null` se a consulta exceder o tempo disponível. Veja a [visão geral de Contatos](https://docs.salez.com.br/contatos/visao-geral.md).


## OpenAPI

````yaml openapi.json POST /contacts/search/count
openapi: 3.0.0
info:
  title: Salez API
  version: v3
  description: >-
    Documentação da API da Salez para consultar, criar e atualizar contatos e
    consultar agendamentos. Para começar, veja a visão geral do módulo Contatos,
    com orientação sobre autenticação e permissões.
servers:
  - url: https://services.leadconnectorhq.com
    description: Servidor da API Salez.
security: []
tags:
  - name: Contatos
    description: Consulta e gerenciamento de contatos da Salez.
paths:
  /contacts/search/count:
    post:
      tags:
        - Contatos
      summary: Contar contatos
      description: >-
        Retorna apenas a quantidade de contatos correspondente aos filtros
        informados, sem carregar todos os registros.
      operationId: salez-post-contacts-search-count
      parameters:
        - name: Version
          in: header
          description: 'Versão obrigatória da API: `v3`.'
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                locationId:
                  type: string
                  description: ID da subconta.
                  example: ve9EPM428h8vShlRW1KT
                query:
                  type: string
                  description: Texto pesquisado.
                  example: Sara
                filters:
                  type: array
                  description: Filtros e grupos lógicos da pesquisa.
                  items:
                    $ref: '#/components/schemas/SalezSearchFilter'
                  example:
                    - field: city
                      operator: eq
                      value: São Paulo
              required:
                - locationId
      responses:
        '200':
          description: Resposta de sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SalezCountResult'
        '400':
          description: Requisição inválida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestDTO'
        '401':
          description: Token inválido ou ausente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedDTO'
        '422':
          description: Dados não processados.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableDTO'
      security:
        - bearer: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl --request POST \
            --url 'https://services.leadconnectorhq.com/contacts/search/count' \
            --header 'Authorization: Bearer <token>' \
            --header 'Version: v3' \
            --header 'Content-Type: application/json' \
            --data '{
              "locationId": "ve9EPM428h8vShlRW1KT",
              "query": "Sara",
              "filters": [
                {
                  "field": "city",
                  "operator": "eq",
                  "value": "São Paulo"
                }
              ]
            }'
components:
  schemas:
    SalezSearchFilter:
      type: object
      description: >-
        Filtro individual (field, operator e value) ou grupo lógico (group e
        filters).
      properties:
        field:
          type: string
          description: >-
            Campo pesquisável: por exemplo `city`, `email`, `tags`,
            `dateUpdated` ou `customFields.{customFieldId}`.
          example: city
        operator:
          type: string
          description: Operador de comparação suportado pelo campo.
          enum:
            - eq
            - not_eq
            - contains
            - not_contains
            - exists
            - not_exists
            - range
            - nested
          example: eq
        value:
          description: >-
            Valor a comparar. Não envie para `exists` ou `not_exists`. Para
            `range`, informe `gte`, `lte`, `gt` ou `lt`.
          oneOf:
            - type: string
            - type: number
            - type: boolean
            - type: array
              items:
                type: string
            - type: object
              additionalProperties: true
        group:
          type: string
          enum:
            - AND
            - OR
          description: Como combinar filtros internos.
          example: OR
        filters:
          type: array
          description: Filtros internos de um grupo lógico.
          items:
            type: object
            additionalProperties: true
    SalezCountResult:
      type: object
      properties:
        count:
          type: integer
          nullable: true
          description: >-
            Total correspondente à pesquisa. Se o processamento exceder o tempo
            disponível, retorna null; refaça a consulta.
          example: 120
      required:
        - count
    BadRequestDTO:
      type: object
      properties:
        statusCode:
          type: number
          example: 400
        message:
          type: string
          example: Bad Request
    UnauthorizedDTO:
      type: object
      properties:
        statusCode:
          type: number
          example: 401
        message:
          type: string
          example: 'Invalid token: access token is invalid'
        error:
          type: string
          example: Unauthorized
    UnprocessableDTO:
      type: object
      properties:
        statusCode:
          type: number
          example: 422
        message:
          example:
            - Unprocessable Entity
          type: array
          items:
            type: string
        error:
          type: string
          example: Unprocessable Entity
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Use um token autorizado da subconta. Gere ou gerencie a integração em
        Configurações > Integrações Privadas na Salez, conforme as permissões do
        usuário. Informe o token no formato Bearer.
      type: http

````

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