> ## Documentation Index
> Fetch the complete documentation index at: https://ajuda.memberkit.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Lista membros

> Retorna uma lista de membros.

### Consulta usando uma query

Você pode usar uma sintaxe semelhante ao SQL para filtrar membros. Insira sua consulta personalizada no parâmetro `query`. Segue abaixo a lista de atributos suportados.

| Descrição            | Atributo                               | Tipo       |
| -------------------- | -------------------------------------- | ---------- |
| Acesso ilimitado     | `unlimited`                            | `boolean`  |
| Última vez visto     | `last_seen_at`                         | `datetime` |
| ID do curso          | `enrollments.course_id`                | `integer`  |
| ID da turma          | `enrollments.classroom_id`             | `integer`  |
| Status da matrícula  | `enrollments.status`                   | `string`   |
| ID da assinatura     | `memberships.membership_level_id`      | `integer`  |
| Status da assinatura | `memberships.status`                   | `string`   |
| ID do convite        | `invite_passes.invite_id`              | `integer`  |
| ID do certificado    | `certificates.certificate_template_id` | `integer`  |
| ID da aula concluída | `lesson_statuses.lesson_id`            | `integer`  |

Para criar uma consulta, você pode utilizar uma ou mais condições, opcionalmente agrupadas por parenteses. Exemplo de consulta de matrículas ativas em um curso:

```
(enrollments.course_id=99 AND enrollments.status=active)
```


## OpenAPI

````yaml GET /api/v1/users
openapi: 3.1.0
info:
  title: MemberKit
  description: ''
  version: 1.0.0
servers: []
security:
  - apikey-query-api_key: []
tags:
  - name: academies
  - name: courses
  - name: lessons
  - name: memberships
  - name: classrooms
  - name: rankings
  - name: users
  - name: scores
  - name: quizzes
  - name: hooks
  - name: comments
paths:
  /api/v1/users:
    get:
      tags:
        - users
      summary: Lista membros
      description: Retorna uma lista de membros.
      parameters:
        - name: page
          in: query
          description: Número da página.
          required: false
          schema:
            type: integer
        - name: query
          in: query
          description: Filtro para busca.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
          headers: {}
      deprecated: false
      security:
        - apikey-query-api_key: []
components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: integer
        full_name:
          type: string
        email:
          type: string
          format: email
        profile_image_url:
          type:
            - string
            - 'null'
        sign_in_count:
          type: integer
        current_sign_in_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - full_name
        - email
        - profile_image_url
        - sign_in_count
        - current_sign_in_at
        - created_at
        - updated_at
  securitySchemes:
    apikey-query-api_key:
      type: apiKey
      in: query
      name: api_key

````