Documentação da API — NEXOOPS
NEXOOPS NEXOOPS
API v1 · REST

Documentação da API NEXOOPS

Integre projetos, timesheet, recursos humanos, talentos e pausas administrativas da plataforma NEXOOPS aos seus próprios sistemas. Uma API REST previsível, com respostas em JSON, autenticação por token e isolamento por workspace (multi-tenant).

Protocolo
HTTPS · REST
Formato
JSON (UTF-8)
Auth
Bearer Token

Base URL

https://www.nexoops.com.br/api

Autenticação

Todas as requisições exigem um token de acesso enviado no cabeçalho Authorization. Gere um token na área Configurações → Integrações do seu workspace. Cada token herda as permissões (RBAC) e o escopo de unidades de negócio do usuário que o criou.

cURL
curl https://www.nexoops.com.br/api/projects \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json"
🔒

Nunca exponha seu token em código de frontend ou repositórios públicos. Requisições sem token válido retornam 401 Não autenticado; sem permissão suficiente, 403.

Convenções

Paginação

Endpoints de listagem aceitam page e limit e devolvem os dados junto de um objeto pagination.

Resposta
{
  "data": [ /* … */ ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 143,
    "total_pages": 8
  }
}

Códigos de status

{{ s.code }} {{ s.label }} {{ s.desc }}

Formato de erro

400 Bad Request
{
  "error": "Dados inválidos",
  "details": [
    { "path": ["name"], "message": "Campo obrigatório" }
  ]
}

{{ g.title }}

{{ g.desc }}

{{ ep.method }} {{ ep.path }}

{{ ep.desc }}

{{ ep.paramsLabel }}
Parâmetro Tipo Descrição
{{ p.name }}{{ p.reqLabel }} {{ p.type }} {{ p.desc }}
Requisição
{{ ep.req }}
Resposta · {{ ep.resCode }}
{{ ep.res }}

Nenhum endpoint encontrado

Tente outro termo de busca.