Search docs/

Buscar membros

{...}

Buscar membros. Essa busca pode ser feita com filtros através dos parâmetros listados bem como texto livre no parâmetro q.

GET https://api.layers.digital/v1/members/search
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
  • status
    (query)
    Indicador do status do usuário. Pode ser ativo (ACTIVE), convidado (INVITED) ou não convidado (INACTIVE)
  • active
    (query)
    Indicador do estado do documento. Quando verdadeiro o documento está ativo e quando falso o documento está apagado.
  • q
    (query)
    Texto de busca. Pode ser o nome ou alias do membro.

Resposta

Especificação

  • totalNumber

    Número de membros encontrados

  • hitsMember[ ]

    Lista de membros encontrados ordenados por quão bem se encaixam na busca

Exemplo

{
  "total": 1,
  "hits": [
    {
      "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