> ## 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.

# Consultar contatos por empresa

> Lista contatos vinculados a uma empresa, com opções de pesquisa e paginação dos resultados.

**URL completa:** `https://services.leadconnectorhq.com/contacts/business/{businessId}`

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


## OpenAPI

````yaml openapi.json GET /contacts/business/{businessId}
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/business/{businessId}:
    get:
      tags:
        - Contatos
      summary: Consultar contatos por empresa
      description: >-
        Consulta os contatos associados a uma empresa por `businessId`, com
        filtros e paginação.


        **Escopo necessário:** `contacts.readonly`.
      operationId: get-contacts-by-business-id
      parameters:
        - name: Version
          in: header
          description: 'Versão obrigatória da API: `v3`.'
          required: true
          schema:
            type: string
        - name: businessId
          in: path
          required: true
          description: ID da empresa.
          schema:
            type: string
            example: 641c094001436dbc2081e642
        - name: locationId
          in: query
          required: true
          description: ID da subconta.
          schema:
            example: ve9EPM428h8vShlRW1KT
            type: string
        - name: limit
          in: query
          required: false
          description: Limite de registros por página (máximo 100, padrão 25).
          schema:
            type: string
            example: '25'
        - name: skip
          in: query
          required: false
          description: Número de registros a pular.
          schema:
            type: string
            example: '0'
        - name: query
          in: query
          required: false
          description: Busca por nome, e-mail ou telefone.
          schema:
            type: string
            example: Sara
        - name: startAfter
          in: query
          required: false
          description: Cursor para paginação (nome,id).
          schema:
            type: object
            example:
              name: Sara Muller
              id: seD4PfOuKoVMLkEZqohJ
      responses:
        '200':
          description: Resposta de sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessContactsResponseSalez'
        '400':
          description: Requisição inválida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestDTO'
        '401':
          description: Não autorizado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedDTO'
        '422':
          description: Não foi possível processar os dados enviados.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableDTO'
      security:
        - bearer: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl --request GET \
              --url 'https://services.leadconnectorhq.com/contacts/business/{businessId}?locationId=<locationId>&limit=25&query=Sara' \
              --header 'Authorization: Bearer <token>' \
              --header 'Version: v3'
components:
  schemas:
    BusinessContactsResponseSalez:
      type: object
      properties:
        contacts:
          type: array
          description: Contatos associados à empresa.
          items:
            $ref: '#/components/schemas/GetContactByIdSchemaV3'
        count:
          type: number
          description: Quantidade total de contatos encontrados.
          example: 10
    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
    GetContactByIdSchemaV3:
      type: object
      properties:
        id:
          type: string
          description: Identificador único do contato.
          example: seD4PfOuKoVMLkEZqohJ
        name:
          type: string
          description: Nome completo do contato.
          example: Sara Muller
        locationId:
          type: string
          description: ID da subconta à qual o contato pertence.
          example: ve9EPM428h8vShlRW1KT
        firstName:
          type: string
          description: Primeiro nome do contato.
          example: Sara
        lastName:
          type: string
          description: Sobrenome do contato.
          example: Muller
        email:
          type: string
          description: Endereço de e-mail do contato.
          example: sara@salez.com.br
        emailLowerCase:
          type: string
          description: E-mail do contato em letras minúsculas.
          example: sara@salez.com.br
        timezone:
          type: string
          description: Fuso horário do contato.
          example: America/Sao_Paulo
        companyName:
          type: string
          description: Nome da empresa do contato.
          example: Salez
        phone:
          type: string
          description: Número de telefone do contato.
          example: '+5511934848735'
        dnd:
          type: boolean
          description: Indica se o modo não perturbe (DND) está habilitado para o contato.
          example: true
        type:
          type: string
          description: Classificação do tipo de contato.
          example: lead
        source:
          type: string
          description: Origem da criação do contato.
          example: Integração API
        assignedTo:
          type: string
          description: ID do usuário responsável pelo contato.
          example: ve9EPM428h8vShlRW1KT
        address1:
          type: string
          description: Endereço do contato.
          example: Av. Pres. Juscelino Kubitschek, 1327
        city:
          type: string
          description: Cidade do contato.
          example: São Paulo
        state:
          type: string
          description: Estado do contato.
          example: SP
        country:
          type: string
          description: País do contato.
          example: BR
        postalCode:
          type: string
          description: Código postal do contato.
          example: 04543-011
        website:
          type: string
          description: URL do site do contato.
          example: https://salez.com.br
        tags:
          description: Lista de etiquetas associadas ao contato.
          example:
            - cliente
            - atendimento
          type: array
          items:
            type: string
        dateOfBirth:
          type: string
          description: Data de nascimento do contato no formato YYYY-MM-DD.
          example: '1990-09-25'
        dateAdded:
          type: string
          description: Data e hora de criação do contato no padrão ISO 8601.
          example: '2021-07-02T05:18:26.704Z'
        dateUpdated:
          type: string
          description: Data e hora da última atualização do contato no padrão ISO 8601.
          example: '2021-07-02T05:18:26.704Z'
        attachments:
          type: string
          description: Lista de URLs de anexos associados ao contato.
          example: []
        ssn:
          type: string
          description: Número de seguridade social dos EUA (SSN), quando aplicável.
        keyword:
          type: string
          description: Palavra-chave de busca associada ao contato.
          example: test
        firstNameLowerCase:
          type: string
          description: Primeiro nome do contato em letras minúsculas.
          example: sara
        fullNameLowerCase:
          type: string
          description: Nome completo do contato em letras minúsculas.
          example: sara muller
        lastNameLowerCase:
          type: string
          description: Sobrenome do contato em letras minúsculas.
          example: muller
        lastActivity:
          type: string
          description: Data e hora da última atividade do contato no padrão ISO 8601.
          example: '2021-07-16T11:39:30.564Z'
        customFields:
          description: Lista de valores dos campos personalizados do contato.
          example:
            - id: 6dvNaf7VhkQ9snc5vnjJ
              key: contato.segmento
              fieldValue: Tecnologia
          type: array
          items:
            $ref: '#/components/schemas/CustomFieldSchema'
        businessId:
          type: string
          description: ID da empresa associada ao contato.
          example: 641c094001436dbc2081e642
        attributionSource:
          description: Dados da origem de atribuição da primeira interação do contato.
          example:
            url: Trigger Link
            campaign: Summer Sale
          allOf:
            - $ref: '#/components/schemas/AttributionSource'
        lastAttributionSource:
          description: Dados da origem de atribuição da última interação do contato.
          example:
            url: Organic Search
            campaign: Brand Awareness
          allOf:
            - $ref: '#/components/schemas/AttributionSource'
        visitorId:
          type: string
          description: >-
            `visitorId` é o identificador único atribuído a cada visitante do
            chat ao vivo.
          example: ve9EPM428h8vShlRW1KT
        dndSettings:
          description: Configurações de não perturbe (DND) por canal do contato.
          example:
            call:
              status: inactive
            email:
              status: inactive
          allOf:
            - $ref: '#/components/schemas/DndSettingsSchemaV3'
    CustomFieldSchema:
      type: object
      properties:
        id:
          type: string
          description: Identificador único do campo personalizado.
          example: MgobCB14YMVKuE4Ka8p1
        value:
          type: string
          description: Valor do campo personalizado.
          example: name
    AttributionSource:
      type: object
      properties:
        url:
          type: string
          description: Tipo de origem da atribuição.
          example: Trigger Link
        campaign:
          type: string
          description: Nome da campanha.
          example: Summer Sale 2024
          nullable: true
        utmSource:
          type: string
          description: Parâmetro UTM de origem.
          example: google
          nullable: true
        utmMedium:
          type: string
          description: Parâmetro UTM de meio.
          example: cpc
          nullable: true
        utmContent:
          type: string
          description: Parâmetro UTM de conteúdo.
          example: ad_variation_1
          nullable: true
        referrer:
          type: string
          description: URL de referência.
          example: https://www.google.com
          nullable: true
        campaignId:
          type: string
          description: ID da campanha.
          example: 641c094001436dbc2081e642
          nullable: true
        fbclid:
          type: string
          description: ID do clique no Facebook.
          example: fb.1.1674748390986.1171287961
          nullable: true
        gclid:
          type: string
          description: ID do clique no Google.
          example: >-
            CjOKCQjwnNyUBhCZARISAI9AYIFtNnIcWcYGIOQINz_ZoFI5SSLRRugSoPZoiEu27IZBY£1-MAIWmEaAo2VEALW_WCB
          nullable: true
        msclikid:
          type: string
          description: ID do clique na Microsoft.
          example: MS!AzEREREDJKSJD
          nullable: true
        dclid:
          type: string
          description: ID do clique no DoubleClick.
          example: EAIaIQobChMIw
          nullable: true
        fbc:
          type: string
          description: ID do navegador no Facebook.
          example: fb.1.1674748390986.1171287961
          nullable: true
        fbp:
          type: string
          description: ID do pixel do Facebook.
          example: fb. 1.1674748390986.1171287961
          nullable: true
        fbEventId:
          type: string
          description: ID do evento no Facebook.
          example: Mozilla/5.0
          nullable: true
        userAgent:
          type: string
          description: Identificação do navegador no formato user agent.
          example: Mozilla/5.0
          nullable: true
        ip:
          type: string
          description: Endereço IP do visitante.
          example: 58.111.106.198
          nullable: true
        medium:
          type: string
          description: Meio de atribuição, como pesquisa ou funil.
          example: survey
          nullable: true
        mediumId:
          type: string
          description: ID do meio de atribuição.
          example: FglfHAn30PRwsZVyQlKp
          nullable: true
      required:
        - url
    DndSettingsSchemaV3:
      type: object
      properties:
        call:
          description: Configurações de não perturbe (DND) para chamadas telefônicas.
          example:
            status: active
            message: Do not call
            code: all
          allOf:
            - $ref: '#/components/schemas/DndSettingSchema'
        email:
          description: Configurações de não perturbe (DND) para e-mail.
          example:
            status: inactive
          allOf:
            - $ref: '#/components/schemas/DndSettingSchema'
        sms:
          description: Configurações de não perturbe (DND) para SMS.
          example:
            status: active
            message: Do not SMS
            code: all
          allOf:
            - $ref: '#/components/schemas/DndSettingSchema'
        whatsApp:
          description: Configurações de não perturbe (DND) para o WhatsApp.
          example:
            status: active
            message: Do not WhatsApp
            code: all
          allOf:
            - $ref: '#/components/schemas/DndSettingSchema'
        gmb:
          description: Configurações de não perturbe (DND) para o Google My Business.
          example:
            status: active
            message: Do not contact via GMB
            code: all
          allOf:
            - $ref: '#/components/schemas/DndSettingSchema'
        fb:
          description: Configurações de não perturbe (DND) para o Facebook.
          example:
            status: active
            message: Do not contact via FB
            code: all
          allOf:
            - $ref: '#/components/schemas/DndSettingSchema'
    DndSettingSchema:
      type: object
      properties:
        status:
          type: string
          description: Status de não perturbe (DND) para este canal.
          enum:
            - active
            - inactive
            - permanent
          example: active
        message:
          type: string
          description: >-
            Mensagem personalizada associada à configuração de não perturbe
            (DND).
          example: Do not contact via this channel
        code:
          type: string
          description: Código ou motivo de não perturbe (DND).
          example: OPTED_OUT
      required:
        - status
  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.