Listar colaboradores - SULTS Developers

GET

pessoas

Listar colaboradores

curl --request GET \
  --url https://api.sults.com.br/v1/pessoas \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.sults.com.br/v1/pessoas', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sults.com.br/v1/pessoas",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

using RestSharp;


var options = new RestClientOptions("https://api.sults.com.br/v1/pessoas");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

[
  {
    "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": "Sabor Mineiro Savassi",
        "id": 1,
        "cargo": {
          "nome": "Franqueado",
          "id": 54
        }
      }
    ],
    "campoAdicional": [
      {
        "valor": "1",
        "id": 103,
        "label": "Conhece Excel"
      }
    ],
    "celular": [
      "99999999999"
    ],
    "telefone": [],
    "email": [
      "ana.ribeiro@sabormineiro.com.br"
    ],
    "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"
  }
]

{
  "error": "Campo responsavel não pode ser vazio ou nulo."
}

{
  "error": "Acesso não autorizado."
}

{
  "error": "Campo responsavel não pode ser vazio ou nulo."
}

<string>

{
  "error": "Campo responsavel não pode ser vazio ou nulo."
}

Authorizations

Authorization

string

header

required

Token gerado através do sistema do SULTS. Deve ser enviado no cabeçalho Authorization de todas as requisições.

Query Parameters

start

integer

default:0

Número da página da listagem, começando em 0. Incremente até a resposta vir vazia ou até atingir totalPage.

Required range: x >= 0

limit

integer

default:100

Quantidade de registros por página. O máximo aceito pela API é 100.

Required range: 1 <= x <= 100

Response

Lista de colaboradores

integer

Código do colaborador

Example:

1

nome

string

Nome do colaborador

Example:

"Fulano da Silva"

ativo

boolean

true: colaborador ativo no sistema. false: colaborador inativo no sistema.

Example:

true

sexo

string

Sexo do colaborador

Example:

"M"

endereco

object

Show child attributes

cpf

string

CPF do colaborador (sem máscara)

Example:

"01234567890"

numeroIdentidade

string

Número de identidade do colaborador

Example:

"45471111111"

dtNascimento

string<date-time>

Data de nascimento do colaborador

Example:

"1991-04-18T00:00:00Z"

empresa

object[]

Unidades às quais o colaborador está vinculado

Show child attributes

campoAdicional

object[]

Campos adicionais do colaborador

Show child attributes

celular

string[]

Celulares do colaborador

telefone

string[]

Telefones do colaborador

string[]

E-mails do colaborador

dtCadastro

string<date-time>

Data de cadastro do colaborador no sistema

Example:

"2024-03-04T13:15:00Z"

dtUltimaAlteracao

string<date-time>

Data da última alteração do cadastro do colaborador

Example:

"2026-08-19T10:02:44Z"

dtInativacao

string<date-time>

Data de inativação do colaborador no sistema

Example:

"2026-09-30T18:00:00Z"

thumbnail

string

Thumbnail (foto) do colaborador

Example:

"http://link-thumbanil-user.com"

estadoCivil

string

Estado civil do colaborador

Example:

"Separado"

nivelEscolaridade

string

Nível de escolaridade do colaborador

Example:

"Médio Completo"

Listar colaboradores

curl --request GET \
  --url https://api.sults.com.br/v1/pessoas \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.sults.com.br/v1/pessoas', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sults.com.br/v1/pessoas",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

using RestSharp;


var options = new RestClientOptions("https://api.sults.com.br/v1/pessoas");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

[
  {
    "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": "Sabor Mineiro Savassi",
        "id": 1,
        "cargo": {
          "nome": "Franqueado",
          "id": 54
        }
      }
    ],
    "campoAdicional": [
      {
        "valor": "1",
        "id": 103,
        "label": "Conhece Excel"
      }
    ],
    "celular": [
      "99999999999"
    ],
    "telefone": [],
    "email": [
      "ana.ribeiro@sabormineiro.com.br"
    ],
    "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"
  }
]

{
  "error": "Campo responsavel não pode ser vazio ou nulo."
}

{
  "error": "Acesso não autorizado."
}

{
  "error": "Campo responsavel não pode ser vazio ou nulo."
}

<string>

{
  "error": "Campo responsavel não pode ser vazio ou nulo."
}