Endpoint: Listagem de Colaboradores

Endpoint de listagem de pessoas cadastradas nas unidades na plataforma da SULTS.

URL: https://api.sults.com.br/v1/pessoas

Método: GET

Observação

Somente pessoas com a situação ativa e que tenham um relacionamento ativo com uma unidade ativa são retornadas. As pessoas são ordenadas pelo nome.

Parâmetros

Headers

Header	Valor
Authorization	<token_de_acesso>

Query parameters

Parâmetro	Valor
start	Início da paginação (número da página). Padrão 0
limit	Número de registros por página. Máximo 100. Padrão 100

Exemplo

fetch("https://api.sults.com.br/v1/pessoas?start=0&limit=100", {
	method: "GET",
	headers: {
		"Authorization": "<token_de_acesso>"
	}
})

Resultado

[
    {
        "id": 1,
        "nome": "Fulano da Silva",
        "ativo": true,
        "sexo": "M",
        "endereco": {
            "uf": "SP",
            "cidade": "São Paulo",
            "complemento": "bloco 5 apto 101",
            "numero": "455",
            "bairro": "Bairro GG",
            "cep": "38025-888",
            "rua": "Rua São Paulo"
        },
        "cpf": "01234567890",
        "numeroIdentidade": "45471111111",
        "dtNascimento": "2022-01-01T12:00:00Z",
        "empresa": [
            {
                "qualificacao": {
                    "nome": "Proprietário",
                    "id": 1
                },
                "nomeFantasia": "Unidade Exemplo 1",
                "id": 1,
                "cargo": {
                    "nome": "Franqueado",
                    "id": 54
                }
            }
        ],
        "campoAdicional": [
            {
                "valor": "",
                "id": 77,
                "label": "peso"
            },
            {
                "valor": "1",
                "id": 103,
                "label": "Conhece Excel"
            }
        ],
        "celular": [
            "99999999999"
        ],
        "telefone": [],
        "email": [
            "email.exemplo.pessoa@exemplo.com"
        ],
        "dtCadastro": "2022-01-01T12:00:00Z",
        "dtUltimaAlteracao": "2022-01-01T12:00:00Z",
        "dtInativacao": "2022-01-01T12:00:00Z",
        "thumbnail": "http://link-thumbanil-user.com",
        "estadoCivil": "Separado",
        "nivelEscolaridade": "Médio Completo"
    }
]

Campos da resposta

Campos principais

Nome Atributo	Tipo	Valor
id	Integer	Código do colaborador
nome	String	Nome do colaborador
sexo	String	Sexo do colaborador
ativo	Boolean	– true Colaborador ativo no sistema – false Colaborador inativo no sitema
cpf	String	Cpf do colaborador
numeroIdentidade	String	Número de identidade do colaborador
dtNascimento	String	Data de nascimento do colaborador
celular	Lista String	Celulares do colaborador
telefone	Lista String	Telefones do colaborador
email	Lista String	E-mails do colaborador
dtCadastro	String	Data de cadastro do colaborador no sistema
dtUltimaAlteracao	String	Data da última alteração do cadastro do colaborador no sistema
dtInativacao	String	Data de inativação do colaborador no sistema
thumbnail	String	Thumbnail do colaborador
estadoCivil	String	Estado civil do colaborador
nivelEscolaridade	Strin	Nível de escolaridade do colaborador

Campos endereço

Nome Atributo	Tipo	Valor
uf	String	Estado do colaborador
cidade	String	Cidade do colaborador
rua	String	Rua do colaborador
numero	String	Número do endereço do colaborador
complemento	String	Complemento do endereço do colaborador
bairro	String	Bairro do colaborador
cep	String	Cep do colaborador

Campos empresa

Nome Atributo	Tipo	Valor
id	Integer	Código da unidade do colaborador
nomeFantasia	String	Nome fantasia da unidade do colaborador
cargo	Objeto Cargo – id – nome	Cargo do colaborador na unidade
qualificacao	Objeto Qualificacao – id – nome	Qualificação do colaborador na unidade

Campos adicionais

Nome Atributo	Tipo	Valor
id	Integer	Código do campo adicional do colaborador
label	String	Nome do campo adicional do colaborador
valor	Dinâmico Observação: Os valores podem variar o tipo.	Valor do campo adicional.
grupo	Objeto Grupo – id – nome Observação: Esse campo pode ser nulo.	Grupo ao qual o campo adicional pertence.