Search docs/

Listar Membros

{...}

Listar membros existentes.

GET https://api.layers.digital/v1/members
CopiarCopiado

Autenticação

Autenticação do tipo Token Bearer é necessária para acessar essa rota. O app deve estar cadastrado para usar a API com a permissão member:read

Parâmetros

  • community-id
    (header)
    obrigatório
    Identificador da comunidade
  • createdAt
    (query)
    Data de criação do documento
  • updateAt
    (query)
    Data da última modificação do documento
  • userId
    (query)
    Identificador do documento.
  • active
    (query)
    Indicador do estado do documento. Quando verdadeiro o documento está ativo e quando falso o documento está apagado.
  • alias
    ()
    Identificador no Layers Education
  • name
    (query)
    Nome

Resposta

Especificação

  • [].idString

    Identificador do documento do membro

  • [].createdAtString

    Data de criação do membro em UTC corrigido para o fuso da comunidade

  • [].updatedAtString

    Data da última modificação do membro em UTC corrido para o fuso da comunidade

  • [].activeBoolean

    Chave que indica se o membro está ativo (quando o membro é apagado, essa chave é mudada para false)

  • [].communityString

    Identificador da communidade do membro

  • [].accessObject[ ]

  • [].nameStringobrigatório

    Nome do membro

  • [].aliasStringobrigatório

    RA do membro

  • [].birthString

    Data de nascimento

Exemplo

[
  {
    "id": "12345678",
    "createdAt": "2020-01-01T00:00:00.000Z",
    "updatedAt": "2020-01-01T00:00:00.000Z",
    "active": true,
    "community": "test",
    "access": [
      {
        "permissions": [
          "guardian"
        ],
        "user": "exemplo"
      }
    ],
    "name": "Gabriel Raniere",
    "alias": "abc123d",
    "birth": "2010-04-10T00:00:00.000Z"
  }
]
CopiarCopiado