API de Integração
Campus

Listar campus

Lista os campus do parceiro, usados em turmas presenciais ou híbridas.

GET
/campus

Autorização

apiToken
Api-Token<token>

Token do parceiro. Gere no painel do parceiro: Configurações > Integrações > API Token (perfil Admin ou Superadmin). Envie só este header: se Authorization também for enviado, ele tem prioridade e a requisição é recusada com 401.

Local: header

Parâmetros de Query

name?string

Nome do campus (busca por trecho, sem diferenciar maiúsculas).

active?string

true ou false.

Valor em

  • "true"
  • "false"
AddressId?integer

ID do endereço.

creator?string

E-mail de quem cadastrou o campus.

page?string

Página (começa em 1).

limit?string

Itens por página (padrão 50).

Corpo da Resposta

application/json

application/json

curl -X GET "https://example.com/campus?page=1&limit=50"
{  "count": 1,  "rows": [    {      "id": 123,      "name": "Provi",      "AddressId": 123,      "creator": "partner_employee@email.com",      "active": true,      "createdAt": "2021-08-06T11:59:58.702Z",      "updatedAt": "2021-08-06T11:59:58.702Z"    }  ]}