Buscar pessoas cadastradas

Requisição

Parâmetros Query

type

string

opcional

tipo de pessoa, pode ser passado como string ou array, para filtrar vários

Exemplo:

Cliente

cnpj

string

opcional

cpf

string

opcional

code

string

opcional

name

string

opcional

razao

string

opcional

nature

string

opcional

Exemplo:

Física ou Jurídica

dateInit

string

opcional

data inicial de criação

Exemplo:

YYYY-MM-DD

dateFinal

string

opcional

data final de criação

Exemplo:

YYYY-MM-DD

lastUpdatedInit

string

opcional

data inicial da última alteração

Exemplo:

YYYY-MM-DD

lastUpdatedFinal

string

opcional

data final da última alteração

Exemplo:

YYYY-MM-DD

Exemplos de Requisição

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET '/people?type=Cliente&cnpj&cpf&code&name&razao&nature=Física ou Jurídica&dateInit=YYYY-MM-DD&dateFinal=YYYY-MM-DD&lastUpdatedInit=YYYY-MM-DD&lastUpdatedFinal=YYYY-MM-DD'

Respostas

🟢200OK

application/json

Sucesso

Body

array of:

_id

string

opcional

name

string

requerido

Exemplo:

Luiz

razao

string

opcional

cnpj

string

opcional

cpf

string

opcional

rg

string

opcional

inscricao

string

opcional

inscricaoMunicipal

string

opcional

icmsCont

enum<string>

opcional

Valores permitidos:

Contribuinte de ICMSContribuinte IsentoNão Contribuinte

type

array[string]

opcional

Valores permitidos:

ClienteFornecedorFuncionárioVendedorTransportadorDestinatárioSeguradora

code

string

opcional

nature

enum<string>

opcional

Valores permitidos:

JurídicaFísica

address

object (Person_address)

opcional

street

string

opcional

number

string

opcional

complement

string

opcional

neighborhood

string

opcional

cep

string

opcional

city

string

opcional

uf

string

opcional

email

string

opcional

phone

string

opcional

cellphone

string

opcional

details

string

opcional

integrations

array[object (Person_integrations) {2}]

opcional

name

string

opcional

id

string

opcional

Exemplo

[
    {
        "_id": "string",
        "name": "Luiz",
        "razao": "string",
        "cnpj": "string",
        "cpf": "string",
        "rg": "string",
        "inscricao": "string",
        "inscricaoMunicipal": "string",
        "icmsCont": "Contribuinte de ICMS",
        "type": [
            "Cliente"
        ],
        "code": "string",
        "nature": "Jurídica",
        "address": {
            "street": "string",
            "number": "string",
            "complement": "string",
            "neighborhood": "string",
            "cep": "string",
            "city": "string",
            "uf": "string"
        },
        "email": "string",
        "phone": "string",
        "cellphone": "string",
        "details": "string",
        "integrations": [
            {
                "name": "string",
                "id": "string"
            }
        ]
    }
]

🟠400Bad Request