Obter Contatos

Este endpoint permite recuperar uma lista paginada de contatos associados a uma empresa específica.

URL Base

A URL base padrão é https://api.pg.iappbr.com.br/api/v1/, seguida pelo endpoint específico do caminho.

Acesso

Para acessar este endpoint, você precisa ter as credenciais de autenticação adequadas e permissões para visualizar contatos da empresa.

Obter todos os contatos

Visão Geral

O endpoint /contact fornece uma maneira eficiente de recuperar contatos em lotes, utilizando paginação baseada em cursores para navegação suave através de grandes conjuntos de dados.

Endpoint

GET /contact

Parâmetros de Query

Parâmetro	Tipo	Padrão	Descrição
limit	integer	10	O número máximo de contatos a serem retornados por página. Mínimo: 10 | Máximo: 100.
after	string	null	O cursor para a próxima página de resultados.
before	string	null	O cursor para a página anterior de resultados.

Requisição na API

curl -X GET 'https://api.pg.iappbr.com.br/api/v1/contact?limit=15&after=CURSOR' \
     -H 'Authorization: Bearer SEU_TOKEN_AQUI' \
     -H 'Content-Type: application/json'

Resposta

A resposta inclui uma lista de contatos e informações de paginação.

Estrutura da Resposta

{
  "contacts": [
    {
      "id": "string",
      "company_id": "string",
      "name": "string",
      "phone_number": "string",
      "email": "string",
      "address": "string",
      "city": "string",
      "state": "string",
      "zip_code": "string",
      "date_of_birth": "2023-06-28T12:00:00Z",
      "gender": "string",
      "last_interaction": "2023-06-28T12:00:00Z",
      "interaction_type": "string",
      "notes": "string",
      "newsletter_subscriber": boolean,
      "referral_source": "string",
      "is_blocked": boolean,
      "social_profiles": {
        "linkedin": "string",
        "facebook": "string",
        "twitter": "string",
        "instagram": "string",
        "threads": "string"
      },
      "custom_fields": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "tags": [
        {
          "id": "string",
          "name": "string",
          "color": "string"
        }
      ]
    }
  ],
  "paging": {
    "cursors": {
      "before": "{cursor}",
      "after": "{cursor}"
    },
    "previous": "https://api.pg.iappbr.com.br/api/v1/contact?limit=15&before={cursor}",
    "next": "https://api.pg.iappbr.com.br/api/v1/contact?limit=15&after={cursor}"
  }
}

Campos da Resposta

• contacts: Array de Contatos

• paging: Informações para navegação entre páginas de resultados.

  • cursors: Cursores para navegação.

    • before: Cursor para a página anterior.

    • after: Cursor para a próxima página.

  • previous: URL completa para a página anterior de resultados.

  • next: URL completa para a próxima página de resultados.

Processo de Paginação

A paginação é baseada em cursores, o que permite uma navegação eficiente através de grandes conjuntos de dados.

• Para obter a próxima página de resultados, use o valor after fornecido na resposta anterior.

• Para obter a página anterior de resultados, use o valor before fornecido na resposta.

Limites e Considerações

• O número máximo de contatos retornados por requisição é 100.

• Se não houver mais resultados disponíveis, os campos next ainda estará disponível.

• Se fora a primeira página, o campo next será null.

• É recomendado usar o valor de limit consistentemente entre as requisições para manter a uniformidade dos resultados.

Obter Detalhes de um Contato

Visão Geral

Recupera informações detalhadas de um contato específico.

Endpoint

GET /contact/{contact_id}

Parâmetros

Nome	Tipo	Local	Descrição
contact_id*	string	path	ID do contato a ser recuperado

* Parâmetro obrigatório

Exemplo de Requisição

curl -X 'GET' \
  'https://api.pg.iappbr.com.br/api/v1/contacts/ID_DO_CONTATO' \
  -H 'Authorization: Bearer SEU_TOKEN_AQUI'
  -H 'accept: application/json'

Resposta

{
  "status": "success",
  "data": {
    "contact": {
      "id": "64daee87d98c6ce330953465",
      "company_id": "string",
      "name": "John Doe",
      "phone_number": "[phone]",
      "email": "[email protected]",
      "address": "123 Main St",
      "city": "Metropolis",
      "state": "NY",
      "zip_code": "12345",
      "date_of_birth": "1980-01-01T00:00:00.000Z",
      "gender": "male",
      "last_interaction": "2024-06-29T03:53:04.010Z",
      "interaction_type": "email",
      "notes": "Customer prefers email communication.",
      "newsletter_subscriber": true,
      "referral_source": "Social Media",
      "is_blocked": false,
      "social_profiles": {
        "linkedin": "linkedin.com/in/johndoe",
        "facebook": "facebook.com/johndoe",
        "twitter": "twitter.com/johndoe",
        "instagram": "instagram.com/johndoe",
        "threads": "threads.net/johndoe"
      },
      "custom_fields": [
        {
          "key": "preferred_language",
          "value": "English"
        }
      ],
      "tags": [
        {
          "id": "tag123",
          "name": "VIP",
          "color": "#FFD700"
        }
      ]
    }
  }
}