API KeysDocumentação

Crie uma API Key para testar os endpoints ao vivo.

Criar API Key

Esta operação consome créditos do seu workspace por chamada.

get /api/v1/companies

Parâmetros

Busca por texto (razão social, nome fantasia, descrição)

Filtrar por domínio do site

Filtrar por estado (UF). Pode repetir para múltiplos.

Porte conforme Receita Federal. Valores: `Micro`, `Pequeno porte`, `Demais`

Segmento TAMZ (ex: `Software B2B`, `Varejo`). Pode repetir.

Código CNAE principal (ex: `6201500`). Pode repetir.

Faixa de faturamento. Valores: `< R$1M`, `R$1M–R$5M`, `R$5M–R$20M`, `R$20M–R$100M`, `R$100M+`

Faixa de funcionários. Valores: `1-10`, `11-50`, `51-200`, `201-500`, `501-1000`, `1001-5000`, `5001-10000`, `10001+`

Página (default: 1)

Resultados por página (default: 20, máx: 100)

Autorização

Informe sua API key gerada em /developer/api-keys

Authorization

bearerAuth
AuthorizationBearer <token>

Informe sua API key gerada em /developer/api-keys

In: header

Query Parameters

q?string

Busca por texto (razão social, nome fantasia, descrição)

Lengthlength <= 200
domain?string

Filtrar por domínio do site

state?array<string>

Filtrar por estado (UF). Pode repetir para múltiplos.

porte?array<string>

Porte conforme Receita Federal. Valores: Micro, Pequeno porte, Demais

segment?array<string>

Segmento TAMZ (ex: Software B2B, Varejo). Pode repetir.

cnae?array<string>

Código CNAE principal (ex: 6201500). Pode repetir.

revenue?array<string>

Faixa de faturamento. Valores: < R$1M, R$1M–R$5M, R$5M–R$20M, R$20M–R$100M, R$100M+

headcount?array<string>

Faixa de funcionários. Valores: 1-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000, 10001+

page?integer

Página (default: 1)

Default1
Range1 <= value
limit?integer

Resultados por página (default: 20, máx: 100)

Default20
Range1 <= value <= 100

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://tamz.ai/api/v1/companies?q=software&domain=totvs.com.br&state=SP&state=RJ"
{
  "data": [
    {
      "id": "018e1234-abcd-7000-8000-000000000001",
      "cnpj": "33000167000101",
      "legal_name": "PETRÓLEO BRASILEIRO S A PETROBRAS",
      "trade_name": "PETROBRAS",
      "status": "Ativa",
      "macro_segment": "Energia & Meio Ambiente",
      "address_state": "RJ",
      "size_range": "10001+",
      "website": "petrobras.com.br"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "offset": 0,
    "total": 4823,
    "has_more": true
  }
}
{
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Invalid parameters"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing API key. Use Authorization: Bearer tamz_xxx or X-API-Key header"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded"
  }
}