Buscar contato

Método

GET https://oapi.ogmma.com.br/v1/contacts/:id

Conceituação

Este endpoint retorna os dados completos de um contato específico, incluindo metadados personalizados, tags e a quantidade de conversas associadas.

Utilize este endpoint para obter todas as informações de um contato antes de realizar operações como atualização ou exclusão.

---

Atributos

Header

Atributo	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Bearer {API_KEY} - Chave de autenticação

Parâmetros de URL

Atributo	Tipo	Obrigatório	Descrição
id	string	Sim	ID do contato

---

Request

cURL

curl -X GET "https://oapi.ogmma.com.br/v1/contacts/{id}" \
  -H "Authorization: Bearer {API_KEY}"

Node.js

const axios = require('axios');

const response = await axios.get(
  'https://oapi.ogmma.com.br/v1/contacts/{id}',
  {
    headers: {
      'Authorization': 'Bearer {API_KEY}'
    }
  }
);

console.log(response.data);

Python

import requests

response = requests.get(
    'https://oapi.ogmma.com.br/v1/contacts/{id}',
    headers={
        'Authorization': 'Bearer {API_KEY}'
    }
)

print(response.json())

---

Response

200 - Success

Retorna os dados completos do contato.

{
  "data": {
    "id": "6650b2c3d4e5f6a7890124",
    "name": "Maria Silva",
    "phone": "5511999990001",
    "email": "maria@email.com",
    "tags": ["vip", "recorrente"],
    "metadata": {
      "empresa": "Acme Ltda",
      "cpf": "123.456.789-00",
      "plano": "premium"
    },
    "conversationCount": 5,
    "createdAt": "2025-05-01T10:00:00Z",
    "updatedAt": "2025-06-10T14:30:00Z"
  }
}

400 - Bad Request

ID do contato inválido.

{
  "message": "O ID informado é inválido.",
  "code": "INVALID_OBJECT_ID"
}

401 - Unauthorized

Chave de API inválida ou ausente.

{
  "message": "Chave de API inválida ou expirada.",
  "code": "UNAUTHORIZED"
}

429 - Too Many Requests

Limite de requisições excedido.

{
  "message": "Limite de requisições excedido. Tente novamente em alguns segundos.",
  "code": "RATE_LIMIT_EXCEEDED"
}