Obter Unidades

Obter todas as Unidades da Instituição

GET /api/v1/unity

Obter Unidades

cURL

curl --request GET \
  --url https://chat.api.toolzz.com.br/api/v1/unity/

200

{
  "items": [
    {
      "id": "<string>",
      "institutionId": "<string>",
      "name": "<string>",
      "isActivated": true,
      "credentialProjectId": "<string>"
    }
  ],
  "unityCount": 123,
  "activeCount": 123,
  "unityLimit": 123
}

O resultado deve conter um array listando todos os widgets

Token de Acesso

Authorization · string

Token de acesso (“Bearer” deve estar antes do token)

Descrição da Resposta

Abaixo você verá a descrição da resposta

items · array · required

Lista de unidades e seus detalhes.

Show items

id · string · required

Identificador único da unidade.

institutionId · string · required

ID da instituição associada.

name · string · required

Nome da unidade.

isActivated · boolean · required

Status de ativação da unidade.

credentialProjectId · string · required

ID do projeto de credencial vinculado à unidade.

unityCount · number · required

Número total de unidades.

activeCount · number · required

Número de unidades ativas.

unityLimit · number · required

Limite máximo de unidades permitidas.

Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido através do cabeçalho de autorização (Authorization) da requisição. Além disso, a API é protegida por outras medidas de segurança para proteger os dados dos usuários.