> ## Documentation Index > Fetch the complete documentation index at: https://developers.sults.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Listar colaboradores > Lista as pessoas cadastradas nas unidades na plataforma do SULTS. 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**. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/pessoas openapi: 3.1.0 info: title: API SULTS version: v1 description: >- API REST do SULTS. Todas as chamadas devem ser autenticadas por um token enviado, puro e sem o prefixo `Bearer`, no cabeçalho HTTP `Authorization`. As datas seguem o formato UTC ISO 8601 (`yyyy-MM-ddTHH:mm:ssZ`) e campos com máscara (CNPJ, telefone, CEP etc.) são retornados sem máscara. Endpoints de listagem paginados aceitam os parâmetros `start` e `limit`. contact: name: Suporte SULTS url: https://ajuda.sults.com.br servers: - url: https://api.sults.com.br description: Produção security: - apiKeyAuth: [] tags: - name: Unidades description: >- Unidades da rede e colaboradores ativos cadastrados no SULTS. Somente leitura: a API não grava unidades nem colaboradores. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado por um administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP. - name: Chamados description: >- Chamados abertos na plataforma e a timeline de cada um, com os endpoints de criação e conclusão. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado por um administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP. - name: Checklist description: >- Avaliações de checklist aplicadas nas unidades, com respostas, check-ins, check-outs e planos de ação. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado por um administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP. - name: Compras description: >- Pedidos de compra e catálogo de produtos da v1, incluindo o cadastro e a edição de produto e a edição de pedido. A v1 de Compras não recebe novas funcionalidades: mix de produtos, etapas de pedido e as próximas novidades do módulo estão só na API v2, que é a indicada para integrações novas de Compras. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado por um administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP. - name: implantacao description: >- Projetos de implantação de novas unidades e as tarefas de cada projeto. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado por um administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP. x-group: Implantação - name: Projetos description: >- Projetos da operação e as tarefas vinculadas a eles. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado por um administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP. - name: expansao description: >- Negócios do funil de Expansão e a timeline de cada um, com o endpoint de criação de negócio. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado por um administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP. x-group: Expansão paths: /v1/pessoas: get: tags: - Unidades summary: Listar colaboradores description: >- Lista as pessoas cadastradas nas unidades na plataforma do SULTS. 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**. operationId: listarColaboradores parameters: - $ref: '#/components/parameters/Start' - $ref: '#/components/parameters/Limit' responses: '200': description: Lista de colaboradores content: application/json: schema: type: array items: $ref: '#/components/schemas/Colaborador' example: - 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 '400': $ref: '#/components/responses/ErroValidacao' '401': $ref: '#/components/responses/TokenInvalido' '404': $ref: '#/components/responses/NaoEncontrado' '429': $ref: '#/components/responses/LimiteDeRequisicoes' 5XX: $ref: '#/components/responses/ErroDoServidor' components: parameters: Start: name: start in: query description: >- Número da página da listagem, começando em `0`. Incremente até a resposta vir vazia ou até atingir `totalPage`. schema: type: integer minimum: 0 default: 0 example: 0 Limit: name: limit in: query description: Quantidade de registros por página. O máximo aceito pela API é `100`. schema: type: integer minimum: 1 maximum: 100 default: 100 example: 100 schemas: Colaborador: type: object properties: id: type: integer description: Código do colaborador example: 1 nome: type: string description: Nome do colaborador example: Fulano da Silva ativo: type: boolean description: >- `true`: colaborador ativo no sistema. `false`: colaborador inativo no sistema. example: true sexo: type: string description: Sexo do colaborador example: M endereco: $ref: '#/components/schemas/EnderecoColaborador' cpf: type: string description: CPF do colaborador (sem máscara) example: '01234567890' numeroIdentidade: type: string description: Número de identidade do colaborador example: '45471111111' dtNascimento: type: string format: date-time description: Data de nascimento do colaborador example: '1991-04-18T00:00:00Z' empresa: type: array items: $ref: '#/components/schemas/ColaboradorEmpresa' description: Unidades às quais o colaborador está vinculado campoAdicional: type: array items: $ref: '#/components/schemas/CampoAdicional' description: Campos adicionais do colaborador celular: type: array items: type: string example: '34988776655' description: Celulares do colaborador telefone: type: array items: type: string example: '3432125000' description: Telefones do colaborador email: type: array items: type: string example: operacoes@sabormineiro.com.br description: E-mails do colaborador dtCadastro: type: string format: date-time description: Data de cadastro do colaborador no sistema example: '2024-03-04T13:15:00Z' dtUltimaAlteracao: type: string format: date-time description: Data da última alteração do cadastro do colaborador example: '2026-08-19T10:02:44Z' dtInativacao: type: string format: date-time description: Data de inativação do colaborador no sistema example: '2026-09-30T18:00:00Z' thumbnail: type: string description: Thumbnail (foto) do colaborador example: http://link-thumbanil-user.com estadoCivil: type: string description: Estado civil do colaborador example: Separado nivelEscolaridade: type: string description: Nível de escolaridade do colaborador example: Médio Completo EnderecoColaborador: type: object properties: uf: type: string description: Estado do colaborador example: MG cidade: type: string description: Cidade do colaborador example: Uberaba rua: type: string description: Rua do colaborador example: Avenida Leopoldino de Oliveira numero: type: string description: Número do endereço do colaborador example: '3200' complemento: type: string description: Complemento do endereço do colaborador example: Sala 12 bairro: type: string description: Bairro do colaborador example: Centro cep: type: string description: CEP do colaborador example: '38026000' ColaboradorEmpresa: type: object properties: id: type: integer description: Código da unidade do colaborador example: 1 nomeFantasia: type: string description: Nome fantasia da unidade do colaborador example: Sabor Mineiro Savassi cargo: type: object description: Cargo do colaborador na unidade properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Franqueado qualificacao: type: object description: Qualificação do colaborador na unidade properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Proprietário CampoAdicional: type: object properties: id: type: integer description: Código do campo adicional example: 1 label: type: string description: Nome do campo adicional example: Rede Sabor Mineiro valor: description: >- Valor do campo adicional. Observação: o tipo do valor pode variar (dinâmico). grupo: type: object description: 'Grupo ao qual o campo adicional pertence. Observação: pode ser nulo.' properties: id: type: integer description: Código do grupo example: 1 nome: type: string description: Nome do grupo example: Cobrança Erro: type: object description: >- Corpo padrão de erro da API. Não existe código de erro interno: decida a sua lógica pelo status HTTP e use a mensagem apenas para logs e diagnóstico. required: - error properties: error: type: string description: >- Mensagem legível, em português, descrevendo a falha. O texto pode mudar: nunca o use como condição de código. example: Campo responsavel não pode ser vazio ou nulo. responses: ErroValidacao: description: >- Erro de validação ou formato errado nos dados de entrada. A API aponta **um campo por vez**: corrija o campo indicado na mensagem, reenvie e repita até o 200. content: application/json: schema: $ref: '#/components/schemas/Erro' example: error: Campo responsavel não pode ser vazio ou nulo. TokenInvalido: description: >- Token ausente ou inválido. Confira: copiado por completo, cabeçalho `Authorization` com o nome exato, valor sem o prefixo `Bearer` e gerado na **Gestão de Tokens v1** (tokens v2 não funcionam nesta API). Sem retry automático. O corpo real é `{"error": "Acesso não autorizado."}`. content: application/json: schema: $ref: '#/components/schemas/Erro' example: error: Acesso não autorizado. NaoEncontrado: description: >- Recurso ou entidade inexistente (por exemplo, um `{id}` do caminho que não existe ou foi excluído no SULTS). Reenviar sem corrigir devolve o mesmo erro. content: application/json: schema: $ref: '#/components/schemas/Erro' LimiteDeRequisicoes: description: >- Limite de requisições excedido: **2 requisições por segundo, por IP**. A resposta é a página HTML padrão do servidor, não JSON, e não há o header `Retry-After`: trate pelo status 429, sem fazer parse do corpo, com espera crescente a partir de 1 segundo. content: text/html: schema: type: string description: >- Página HTML padrão do servidor. Não faça parse; decida pelo status. ErroDoServidor: description: >- Falha inesperada do servidor (raro). Repita com espera crescente; persistindo, acione o suporte com data, hora e endpoint. content: application/json: schema: $ref: '#/components/schemas/Erro' securitySchemes: apiKeyAuth: type: apiKey in: header name: Authorization description: >- Token gerado através do sistema do SULTS. Deve ser enviado no cabeçalho `Authorization` de todas as requisições. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.