Pular para o conteúdo principal

Pessoas (Persons)

Gerencie pessoas (clientes, fornecedores, leads, contatos) vinculadas a sua empresa.

Listar Pessoas

GET /external/v1/persons

Retorna uma lista paginada de pessoas.

Query Parameters:

ParametroTipoObrigatorioDescricao
pagenumberNaoPagina atual (default: 1)
limitnumberNaoItens por pagina (default: 20, max: 100)
searchstringNaoBusca por nome, razao social ou documento
personTypestringNaoFiltro por tipo: INDIVIDUAL ou COMPANY
classificationstringNaoFiltro por classificacao: CUSTOMER, SUPPLIER, LEAD, PARTNER
orderBystringNaoCampo de ordenacao: name, createdAt (default: createdAt)
orderstringNaoDirecao: ASC ou DESC (default: DESC)

Exemplo de requisicao:

curl -X GET "https://api.tesselys.com.br/external/v1/persons?page=1&limit=10&personType=COMPANY" \
-H "Authorization: Bearer {accessToken}" \
-H "x-company-token: {companyToken}"

Resposta (200):

{
"data": [
{
"id": "clx1a2b3c4d5e6f7g8h9i0j1",
"name": "Tech Solutions Ltda",
"socialName": "Tech Solutions Tecnologia Ltda",
"documentNumber": "12345678000190",
"personType": "COMPANY",
"email": "contato@techsolutions.com.br",
"phone": "+5511999998888",
"genre": null,
"country": "BR",
"classifications": ["CUSTOMER", "PARTNER"],
"tags": ["tecnologia", "enterprise"],
"isActive": true,
"createdAt": "2026-01-15T10:30:00.000Z",
"updatedAt": "2026-02-20T14:45:00.000Z"
}
],
"meta": {
"total": 142,
"page": 1,
"limit": 10,
"totalPages": 15
}
}

Buscar Pessoa por ID

GET /external/v1/persons/:id

Exemplo de requisicao:

curl -X GET "https://api.tesselys.com.br/external/v1/persons/clx1a2b3c4d5e6f7g8h9i0j1" \
-H "Authorization: Bearer {accessToken}" \
-H "x-company-token: {companyToken}"

Resposta (200):

{
"id": "clx1a2b3c4d5e6f7g8h9i0j1",
"name": "Tech Solutions Ltda",
"socialName": "Tech Solutions Tecnologia Ltda",
"documentNumber": "12345678000190",
"personType": "COMPANY",
"email": "contato@techsolutions.com.br",
"phone": "+5511999998888",
"genre": null,
"country": "BR",
"classifications": ["CUSTOMER", "PARTNER"],
"tags": ["tecnologia", "enterprise"],
"address": {
"street": "Av. Paulista",
"number": "1000",
"complement": "Sala 501",
"neighborhood": "Bela Vista",
"city": "Sao Paulo",
"state": "SP",
"zipCode": "01310-100",
"country": "BR"
},
"isActive": true,
"createdAt": "2026-01-15T10:30:00.000Z",
"updatedAt": "2026-02-20T14:45:00.000Z"
}

Resposta (404):

{
"statusCode": 404,
"message": "RESOURCE_NOT_FOUND",
"friendlyMessage": "Pessoa nao encontrada."
}

Criar Pessoa

POST /external/v1/persons

Body:

CampoTipoObrigatorioDescricao
namestringSimNome ou razao social (max: 255)
socialNamestringNaoNome fantasia
documentNumberstringNaoCPF (11 digitos) ou CNPJ (14 digitos), apenas numeros
personTypestringSimINDIVIDUAL (pessoa fisica) ou COMPANY (pessoa juridica)
emailstringNaoEmail principal
phonestringNaoTelefone com DDI (ex: +5511999998888)
genrestringNaoMALE, FEMALE ou OTHER (apenas para INDIVIDUAL)
countrystringNaoCodigo ISO 3166-1 alpha-2 (default: BR)
classificationsstring[]NaoArray: CUSTOMER, SUPPLIER, LEAD, PARTNER
tagsstring[]NaoTags livres para organizacao

Exemplo de requisicao:

curl -X POST "https://api.tesselys.com.br/external/v1/persons" \
-H "Authorization: Bearer {accessToken}" \
-H "x-company-token: {companyToken}" \
-H "Content-Type: application/json" \
-d '{
"name": "Maria Oliveira",
"documentNumber": "12345678901",
"personType": "INDIVIDUAL",
"email": "maria.oliveira@email.com",
"phone": "+5521988887777",
"genre": "FEMALE",
"country": "BR",
"classifications": ["CUSTOMER"],
"tags": ["vip", "indicacao"]
}'

Resposta (201):

{
"id": "clx2b3c4d5e6f7g8h9i0j1k2",
"name": "Maria Oliveira",
"socialName": null,
"documentNumber": "12345678901",
"personType": "INDIVIDUAL",
"email": "maria.oliveira@email.com",
"phone": "+5521988887777",
"genre": "FEMALE",
"country": "BR",
"classifications": ["CUSTOMER"],
"tags": ["vip", "indicacao"],
"isActive": true,
"createdAt": "2026-03-25T08:00:00.000Z",
"updatedAt": "2026-03-25T08:00:00.000Z"
}

Atualizar Pessoa

PUT /external/v1/persons/:id

Atualiza os dados de uma pessoa existente. Envie apenas os campos que deseja alterar.

Exemplo de requisicao:

curl -X PUT "https://api.tesselys.com.br/external/v1/persons/clx2b3c4d5e6f7g8h9i0j1k2" \
-H "Authorization: Bearer {accessToken}" \
-H "x-company-token: {companyToken}" \
-H "Content-Type: application/json" \
-d '{
"email": "maria.novo@email.com",
"classifications": ["CUSTOMER", "PARTNER"],
"tags": ["vip", "indicacao", "premium"]
}'

Resposta (200):

{
"id": "clx2b3c4d5e6f7g8h9i0j1k2",
"name": "Maria Oliveira",
"socialName": null,
"documentNumber": "12345678901",
"personType": "INDIVIDUAL",
"email": "maria.novo@email.com",
"phone": "+5521988887777",
"genre": "FEMALE",
"country": "BR",
"classifications": ["CUSTOMER", "PARTNER"],
"tags": ["vip", "indicacao", "premium"],
"isActive": true,
"createdAt": "2026-03-25T08:00:00.000Z",
"updatedAt": "2026-03-25T09:15:00.000Z"
}

Valores de Enum

personType

ValorDescricao
INDIVIDUALPessoa fisica
COMPANYPessoa juridica

genre

ValorDescricao
MALEMasculino
FEMALEFeminino
OTHEROutro

classifications

ValorDescricao
CUSTOMERCliente
SUPPLIERFornecedor
LEADLead / Prospect
PARTNERParceiro