Skip to main content
GET
/
contatos
Listar contatos
curl --request GET \
  --url https://api.tiny.com.br/public-api/v3/contatos \
  --header 'Authorization: Bearer <token>'
{
  "itens": [
    {
      "nome": "<string>",
      "codigo": "<string>",
      "fantasia": "<string>",
      "tipoPessoa": "J",
      "cpfCnpj": "<string>",
      "inscricaoEstadual": "<string>",
      "rg": "<string>",
      "telefone": "<string>",
      "celular": "<string>",
      "email": "<string>",
      "endereco": {
        "endereco": "<string>",
        "numero": "<string>",
        "complemento": "<string>",
        "bairro": "<string>",
        "municipio": "<string>",
        "cep": "<string>",
        "uf": "<string>",
        "pais": "<string>"
      },
      "id": 123,
      "vendedor": {
        "id": 123,
        "nome": "<string>"
      },
      "situacao": "B",
      "statusCrm": "L",
      "dataCriacao": "<string>",
      "dataAtualizacao": "<string>"
    }
  ],
  "paginacao": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Query Parameters

nome
string

Pesquisa por nome parcial ou completo

codigo
string

Pesquisa por codigo completo

situacao
enum<string>

Pesquisa por situacao

  • B - Ativo
  • A - Ativo Com Acesso Sistema
  • I - Inativo
  • E - Excluido
Available options:
B,
A,
I,
E
idVendedor
integer

Pesquisa por vendedor padrão

cpfCnpj
string

Pesquisa por CPF ou CNPJ

celular
string

Pesquisa pelo celular

dataCriacao
string

Pesquisa por data de criação

Example:

"2023-01-01 10:00:00"

dataAtualizacao
string

Pesquisa por data de atualização

Example:

"2023-01-01 10:00:00"

orderBy
enum<string>

Define a ordenação da listagem por ordem crescente ou decrescente

  • asc - Crescente
  • desc - Descrescente
Available options:
asc,
desc
limit
integer
default:100

Limite da paginação

offset
integer
default:0

Offset da paginação

Response

OK

itens
· object[]
paginacao
· object