API KeysDocumentação

Crie uma API Key para testar os endpoints ao vivo.

Criar API Key
get /api/v1/owners

Parâmetros

Nome completo ou parcial do sócio (mín. 3 caracteres)

Máximo de resultados (default: 10, máx: 20)

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

name*string

Nome completo ou parcial do sócio (mín. 3 caracteres)

Length3 <= length <= 100
limit?integer

Máximo de resultados (default: 10, máx: 20)

Default10
Range1 <= value <= 20

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://tamz.ai/api/v1/owners?name=Jo%C3%A3o+Silva"
{
  "data": [
    {
      "person_id": "018e1234-abcd-7000-8000-000000000042",
      "person_name": "João Silva Santos",
      "role": "Sócio-Administrador",
      "company_name": "ACME TECNOLOGIA LTDA",
      "cnpj": "12345678000190",
      "segment": "Software B2B",
      "state": "SP"
    }
  ],
  "meta": {
    "total": 1
  }
}
{
  "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"
  }
}