# Curseduca Members

### Membros

<details>

<summary>GET / members / by - Listar membros por campo</summary>

**Parameters**

| Name                                    | Description |
| --------------------------------------- | ----------- |
| <p>email</p><p>string</p><p>(query)</p> | email       |

**Responses**

<table><thead><tr><th width="87.111083984375">Code</th><th width="508.22216796875">Description</th><th width="60.22216796875">Links</th></tr></thead><tbody><tr><td>200</td><td><p>Membros listados com sucesso.</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "id": 0,
  "name": "string",
  "email": "string",
  "image": "string",
  "lastLogin": "2025-07-10T20:59:30.314Z"
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>400</td><td><p>Requisição inválida, query não fornecida</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>401</td><td><p>API Key inválida</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

<details>

<summary>GET / members / {id} - Listar as informações de um membro</summary>

**Parameters**

| Name                            | Description |
| ------------------------------- | ----------- |
| <p>id \*</p><p>string(path)</p> | id          |

**Responses**

<table><thead><tr><th width="82.66668701171875">Code</th><th>Description</th><th width="74.99993896484375">Links</th></tr></thead><tbody><tr><td>200</td><td><p>Membro encontrado com sucesso.</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "id": 0,
  "name": "string",
  "email": "string",
  "document": "string",
  "situation": "string",
  "image": "string",
  "path": "string",
  "description": "string",
  "slug": "string",
  "groups": [
    {
      "group": {
        "id": 0,
        "name": "string",
        "expiresAt": "2025-07-10T21:03:17.827Z"
      },
      "externalReference": "string",
      "createdAt": "2025-07-10T21:03:17.827Z"
    }
  ],
  "createdAt": "2025-07-10T21:03:17.827Z",
  "updatedAt": "2025-07-10T21:03:17.827Z",
  "lastLogin": "2025-07-10T21:03:17.827Z"
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

<details>

<summary>PATCH / members / {id} - Atualizar as informações de um membro</summary>

**Parameters**

| Name                            | Description |
| ------------------------------- | ----------- |
| <p>id \*</p><p>string(path)</p> | id          |

**Request body**                                                                                                              `application/json`

* Example Value

```json
{
  "name": "string",
  "email": "string",
  "document": "string"
}
```

**Responses**

<table><thead><tr><th width="84.888916015625">Code</th><th>Description</th><th width="74.8887939453125">Links</th></tr></thead><tbody><tr><td>200</td><td>Membro atualizado com sucesso!</td><td><em>No links</em></td></tr><tr><td>401</td><td><p>API Key inválida</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>403</td><td><p>Acesso negado, token de acesso inválido</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>404</td><td><p>Membro não encontrado.</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

<details>

<summary>GET / members / {id} / address - Retorna o endereço de um membro</summary>

**Parameters**

| Name                            | Description |
| ------------------------------- | ----------- |
| <p>id \*</p><p>string(path)</p> | id          |

**Responses**

<table><thead><tr><th width="81.5555419921875">Code</th><th width="481.4444580078125">Description</th><th width="68">Links</th></tr></thead><tbody><tr><td>200</td><td><p>Membros listados com sucesso.</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "id": 0,
  "memberId": 0,
  "number": "string",
  "complement": "string",
  "street": "string",
  "neighborhood": "string",
  "city": "string",
  "state": "string",
  "country": "string",
  "zipcode": "string",
  "latitude": "string",
  "longitude": "string"
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

<details>

<summary>GET / members - Listar todos os membros</summary>

**Parameters**

| Name                                                         | Description                                           |
| ------------------------------------------------------------ | ----------------------------------------------------- |
| <p>limit</p><p>number</p><p>(query)</p>                      | limit                                                 |
| <p>offset</p><p>number</p><p>(query)</p>                     | offset                                                |
| <p>startCreatedAt</p><p>string($date-time)</p><p>(query)</p> | startCreatedAt                                        |
| <p>endCreatedAt</p><p>string($date-time)</p><p>(query)</p>   | endCreatedAt                                          |
| <p>startUpdatedAt</p><p>string($date-time)</p><p>(query)</p> | startUpdatedAt                                        |
| <p>endUpdatedAt</p><p>string($date-time)</p><p>(query)</p>   | endUpdatedAt                                          |
| <p>groupId</p><p>string</p><p>(query)</p>                    | groupId                                               |
| <p>neverLogged</p><p>string</p><p>(query)</p>                | <p><em>Available values</em> : true, false</p><p></p> |

**Responses**

<table><thead><tr><th width="81.5555419921875">Code</th><th width="548.111083984375">Description</th><th width="84.6666259765625">Links</th></tr></thead><tbody><tr><td>200</td><td><p>Membros listados com sucesso.</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "metadata": {
    "totalCount": 0,
    "limit": 0,
    "offset": 0,
    "hasMore": true
  },
  "data": [
    {
      "name": "string",
      "email": "string",
      "document": {
        "type": "string",
        "value": "string"
      },
      "situation": "string",
      "image": "string",
      "path": "string",
      "description": "string",
      "slug": "string",
      "lastAccess": "2025-07-10T21:23:42.365Z",
      "createdAt": "2025-07-10T21:23:42.365Z",
      "updatedAt": "2025-07-10T21:23:42.365Z",
      "tenants": [
        {
          "id": 0,
          "uuid": "string",
          "name": "string",
          "slug": "string"
        }
      ]
    }
  ]
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

<details>

<summary>PATCH /members - Atualizar as informações de um membro</summary>

**Parameters**

No parameters

**Responses**

<table><thead><tr><th width="84.888916015625">Code</th><th>Description</th><th width="79.333251953125">Links</th></tr></thead><tbody><tr><td>200</td><td>Membro atualizado com sucesso!</td><td><em>No links</em></td></tr><tr><td>401</td><td><p>API Key inválida</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>403</td><td><p>Acesso negado, token de acesso inválido</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>404</td><td><p>Membro não encontrado.</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

<details>

<summary>POST / members - Cadastrar um novo usuário com funções administrativas</summary>

**Parameters**

No parameters

**Request body**                                                                                                           `application/json`

* Example Value

```json
{
  "name": "string",
  "email": "string",
  "password": "string",
  "tag": "string",
  "group": {
    "id": 0,
    "externalReference": "string"
  },
  "notifications": [
    {
      "type": "EMAIL"
    }
  ],
  "sendMemberRegisteredEmail": true
}
```

**Responses**

<table><thead><tr><th width="84.888916015625">Code</th><th width="554.888916015625">Description</th><th width="81.333251953125">Links</th></tr></thead><tbody><tr><td>201</td><td><p>Membro criado com sucesso!</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "id": 0,
  "uuid": "string",
  "email": "string",
  "links": [
    {
      "type": "string",
      "rel": "PASSWORD_DEFINITION_INTERFACE",
      "link": "string"
    }
  ]
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>400</td><td><p>Paramêtros obrigatórios faltando</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>401</td><td><p>API Key inválida</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

<details>

<summary>POST / members / tenants - Adicionar membro em subplataforma.</summary>

**Parameters**

No parameters

**Request body**                                                                                                           `application/json`

* Example Value

```json
{
  "member": {
    "id": 0,
    "uuid": "string",
    "role": "string"
  },
  "tenant": {
    "id": 0,
    "uuid": "string",
    "name": "string",
    "slug": "string"
  }
}
```

**Responses**

| Code | Description | Links      |
| ---- | ----------- | ---------- |
| 201  |             | *No links* |

</details>

### Default

<details>

<summary>GET / member-current-login</summary>

**Parameters**

No parameters

**Responses**

| Code | Description | Links      |
| ---- | ----------- | ---------- |
| 200  |             | *No links* |

</details>

<details>

<summary>GET / verify-member-access-to-community</summary>

**Parameters**

No parameters

**Responses**

| Code | Description | Links      |
| ---- | ----------- | ---------- |
| 200  |             | *No links* |

</details>

<details>

<summary>GET /verify-member-access-to-mural</summary>

**Parameters**

No parameters

**Responses**

| Code | Description | Links      |
| ---- | ----------- | ---------- |
| 200  |             | *No links* |

</details>

<details>

<summary>POST / onboarding / done</summary>

**Parameters**

No parameters

**Responses**

| Code | Description | Links      |
| ---- | ----------- | ---------- |
| 201  |             | *No links* |

</details>

<details>

<summary>GET / reports / groups</summary>

**Parameters**

No parameters

**Responses**

| Code | Description | Links      |
| ---- | ----------- | ---------- |
| 200  |             | *No links* |

</details>

<details>

<summary>GET / reports / group / contents</summary>

**Parameters**

No parameters

**Responses**

| Code | Description | Links      |
| ---- | ----------- | ---------- |
| 200  |             | *No links* |

</details>

<details>

<summary>GET / reports / group / channels</summary>

**Parameters**

No parameters

**Responses**

| Code | Description | Links      |
| ---- | ----------- | ---------- |
| 200  |             | *No links* |

</details>

<details>

<summary>GET / reports / group / members</summary>

**Parameters**

No parameters

**Responses**

| Code | Description | Links      |
| ---- | ----------- | ---------- |
| 200  |             | *No links* |

</details>

<details>

<summary>GET / reports / group / integrations</summary>

**Parameters**

No parameters

**Responses**

| Code | Description | Links      |
| ---- | ----------- | ---------- |
| 200  |             | *No links* |

</details>

<details>

<summary>GET / hc</summary>

**Parameters**

No parameters

**Responses**

| Code | Description | Links      |
| ---- | ----------- | ---------- |
| 200  |             | *No links* |

</details>

<details>

<summary>PATCH / inactivate-member</summary>

**Parameters**

No parameters

**Responses**

| Code | Description | Links      |
| ---- | ----------- | ---------- |
| 200  |             | *No links* |

</details>

<details>

<summary>PATCH / reactivate-member</summary>

**Parameters**

No parameters

**Responses**

| Code | Description | Links      |
| ---- | ----------- | ---------- |
| 200  |             | *No links* |

</details>

<details>

<summary>POST / me / mark-access</summary>

**Parameters**

No parameters

**Responses**

| Code | Description | Links      |
| ---- | ----------- | ---------- |
| 201  |             | *No links* |

</details>

<details>

<summary>GET / reports / tags</summary>

**Parameters**

No parameters

**Responses**

| Code | Description | Links      |
| ---- | ----------- | ---------- |
| 200  |             | *No links* |

</details>

<details>

<summary>GET / search / admin</summary>

**Parameters**

| Name                                 | Description |
| ------------------------------------ | ----------- |
| <p>search \*</p><p>string(query)</p> | search      |
| <p>limit \*</p><p>string(query)</p>  | limit       |
| <p>entity \*</p><p>string(query)</p> | entity      |

**Responses**

| Code | Description | Links      |
| ---- | ----------- | ---------- |
| 200  |             | *No links* |

</details>

### Ações do membro

#### Autenticação

<details>

<summary>PATCH / password - Alterar a senha do membro</summary>

**Parameters**

No parameters

**Request body**                                                                                         `application/json`

* Example Value

```json
{
  "oldPassword": "string",
  "newPassword": "string"
}
```

**Responses**

<table><thead><tr><th width="84.88885498046875">Code</th><th width="547.111083984375">Description</th><th width="68">Links</th></tr></thead><tbody><tr><td>200</td><td><p>Senha alterada com sucesso!</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "id": 0
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>400</td><td><p>Paramêtros obrigatórios faltando</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>401</td><td><p>API Key inválida</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>403</td><td><p>Acesso negado, credenciais inválidas</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

<details>

<summary>POST/password/forgot - Esqueci minha senha</summary>

**Parameters**

No parameters

**Request body**                                                                                                           `application/json`

* Example Value

```json
{
  "username": "string"
}
```

**Responses**

<table><thead><tr><th width="84.88885498046875">Code</th><th width="541.5555419921875">Description</th><th width="68">Links</th></tr></thead><tbody><tr><td>201</td><td>Operação executada com sucesso. Também retornado caso o usuário não exista.</td><td><em>No links</em></td></tr><tr><td>400</td><td><p>Email inválido.</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

<details>

<summary>POST /login - Retornar as credenciais de login</summary>

**Parameters**

| Name                                             | Description |
| ------------------------------------------------ | ----------- |
| <p>redirectUrl \*</p><p>string</p><p>(query)</p> | redirectUrl |

**Request body**                                                                                           `application/json`

* Example Value

```json
{
  "username": "string",
  "password": "string",
  "device": {
    "app": {
      "uuid": "string"
    },
    "device": "string",
    "registrationToken": "string"
  },
  "accessTokenValidity": "string"
}
```

**Responses**

<table><thead><tr><th width="87.111083984375">Code</th><th>Description</th><th width="70.333251953125">Links</th></tr></thead><tbody><tr><td>201</td><td><p>Membro logado com sucesso!</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "accessToken": "string",
  "refreshToken": "string",
  "expiresAt": "2025-07-10T22:50:58.774Z",
  "redirectUrl": "string"
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>400</td><td><p>Paramêtros obrigatórios faltando</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>401</td><td><p>API Key inválida</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

<details>

<summary>POST / refresh - Gerar novo token de acesso</summary>

**Parameters**

No parameters

**Request body**                                                                                          `application/json`

* Example Value

```json
{
  "refreshToken": "string",
  "device": {
    "app": {
      "uuid": "string"
    },
    "device": "string",
    "registrationToken": "string"
  }
}
```

**Responses**

<table><thead><tr><th width="84.88885498046875">Code</th><th>Description</th><th width="67.11102294921875">Links</th></tr></thead><tbody><tr><td>201</td><td><p>Token gerado com sucesso!</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "accessToken": "string",
  "expiresAt": "2025-07-11T00:18:43.866Z"
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>401</td><td><p>Token inválido</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

<details>

<summary>POST /register - Cadastrar um novo usuário</summary>

**Parameters**

No parameters

**Request body**                                                                                                        `application/json`

* Example Value

```json
{
  "name": "string",
  "email": "string",
  "password": "string",
  "document": "string",
  "phones": {
    "mobile": "string",
    "home": "string"
  },
  "sendConfirmationEmail": true,
  "contentsToEnroll": [
    "string"
  ],
  "username": "string",
  "products": [
    "string"
  ],
  "birthDate": "2025-07-11T00:21:22.767Z",
  "address": {
    "zipCode": "string",
    "street": "string",
    "number": "string",
    "complement": "string",
    "city": "string",
    "state": "string"
  }
}
```

**Responses**

<table><thead><tr><th width="90.4444580078125">Code</th><th width="514.111083984375">Description</th><th width="75.7777099609375">Links</th></tr></thead><tbody><tr><td>201</td><td><p>Membro criado com sucesso!</p><p></p><p>Media type:</p><p></p><p><code>application/json</code>  </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "id": 0
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>400</td><td><p>Paramêtros obrigatórios faltando</p><p></p><p>Media type</p><p></p><p><code>application/json</code> </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>401</td><td><p>API Key inválida</p><p></p><p>Media type</p><p></p><p><code>application/json</code> </p><p></p><ul><li>Example Value</li></ul><p></p><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>409</td><td><p>E-mail já cadastrado</p><p></p><p>Media type</p><p></p><p><code>application/json</code></p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

#### Perfil

<details>

<summary>POST /me / fields - Criar um novo campo</summary>

**Parameters**

No parameters

**Request body**                                                                                                   `application/json`

* Example Value

```json
{
  "fieldSchema": {
    "id": 0
  },
  "value": "string"
}
```

**Responses**

<table><thead><tr><th width="84.888916015625">Code</th><th>Description</th><th width="77.1109619140625">Links</th></tr></thead><tbody><tr><td>201</td><td>Campo criado com sucesso!</td><td><em>No links</em></td></tr><tr><td>401</td><td><p>API Key inválida</p><p></p><p>Media type</p><p></p><p><code>application/json</code> </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>403</td><td><p>Acesso negado, token de acesso inválido</p><p></p><p>Media type</p><p></p><p><code>application/json</code> </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>404</td><td><p>Membro ou modelo de campo não encontrado.</p><p>Media typeapplication/json</p><ul><li><p></p><p>Media type</p><p></p><p><code>application/json</code> </p><p></p><ul><li>Example Value</li></ul></li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

<details>

<summary>PATCH / me - Atualizar membro</summary>

**Parameters**

No parameters

**Request body**                                                                                                         `application/json`

* Example Value

```json
{
  "name": "string",
  "email": "string",
  "document": "string"
}
```

**Responses**

<table><thead><tr><th width="85.99993896484375">Code</th><th>Description</th><th width="83.77777099609375">Links</th></tr></thead><tbody><tr><td>200</td><td>Membro atualizado com sucesso!</td><td><em>No links</em></td></tr><tr><td>401</td><td><p>API Key inválida</p><p></p><p>Media type</p><p></p><p><code>application/json</code> </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>403</td><td><p>Acesso negado, token de acesso inválido</p><p></p><p>Media type</p><p></p><p><code>application/json</code> </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>404</td><td><p>Membro não encontrado.</p><p></p><p>Media type</p><p></p><p><code>application/json</code> </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

<details>

<summary>DELETE / me - Inativar membro</summary>

**Parameters**

No parameters

**Responses**

<table><thead><tr><th width="84.888916015625">Code</th><th>Description</th><th width="72.6666259765625">Links</th></tr></thead><tbody><tr><td>200</td><td>Membro inativado com sucesso!</td><td><em>No links</em></td></tr><tr><td>401</td><td><p>API Key inválida</p><p></p><p>Media type</p><p></p><p><code>application/json</code> </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>403</td><td><p>Acesso negado, token de acesso inválido</p><p></p><p>Media type</p><p></p><p><code>application/json</code> </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr><tr><td>404</td><td><p>Membro não encontrado.</p><p></p><p>Media type</p><p></p><p><code>application/json</code> </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

<details>

<summary>GET / me</summary>

**Parameters**

| Name                                    | Description |
| --------------------------------------- | ----------- |
| <p>skipCache \*</p><p>string(query)</p> | skipCache   |

**Responses**

<table><thead><tr><th width="83.77777099609375">Code</th><th>Description</th><th width="67.22210693359375">Links</th></tr></thead><tbody><tr><td>200</td><td><p>Membro encontrado com sucesso!</p><p></p><p>Media type</p><p></p><p><code>application/json</code> </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "uuid": "string",
  "id": 0,
  "name": "string",
  "email": "string",
  "image": "string",
  "termsOfUse": {
    "status": "SIGNED",
    "title": "string",
    "file": "string"
  },
  "slug": "string",
  "headline": "string"
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

### Deep Links

<details>

<summary>POST / members / groups - Cadastrar membro em um grupo</summary>

**Parameters**

No parameters

**Request body**                                                                                                       `application/json`

* Example Value

```json
{
  "member": {
    "id": 0,
    "uuid": "string",
    "role": "string"
  },
  "group": {
    "id": 0
  },
  "customExpirationDate": "2025-07-11T00:39:13.151Z"
}
```

**Responses**

<table><thead><tr><th width="82.66668701171875">Code</th><th>Description</th><th width="76.11102294921875">Links</th></tr></thead><tbody><tr><td>201</td><td>Membro adicionado na turma com sucesso!</td><td><em>No links</em></td></tr><tr><td>400</td><td><p>Paramêtros obrigatórios não foram informados</p><p></p><p>Media type</p><p></p><p><code>application/json</code> </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

<details>

<summary>POST / members / groups / test</summary>

**Parameters**

No parameters

**Request body**                                                                                                        `application/json`

* Example Value

```json
{}
```

**Responses**

<table><thead><tr><th width="91.55548095703125">Code</th><th>Description</th><th>Links</th></tr></thead><tbody><tr><td>201</td><td></td><td><em>No links</em></td></tr></tbody></table>

</details>

<details>

<summary>DELETE / members / {member} / groups / {groupId} - Remover membro de um grupo</summary>

**Parameters**

| Name                                        | Description |
| ------------------------------------------- | ----------- |
| <p>member \*</p><p>number</p><p>(path)</p>  | member      |
| <p>groupId \*</p><p>number</p><p>(path)</p> | groupId     |

**Responses**

<table><thead><tr><th width="84.88885498046875">Code</th><th>Description</th><th width="79.33331298828125">Links</th></tr></thead><tbody><tr><td>201</td><td>Membro removido da turma com sucesso!</td><td><em>No links</em></td></tr><tr><td>400</td><td><p>Paramêtros obrigatórios não foram informados</p><p></p><p>Media type</p><p></p><p><code>application/json</code> </p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

<details>

<summary>POST/members/groups/batch - Cadastrar membro em um grupo</summary>

**Parameters**

No parameters

**Request body**                                                                                                          `application/json`

* Example Value

```json
{
  "member": {
    "id": 0,
    "uuid": "string",
    "role": "string"
  },
  "groups": [
    "string"
  ],
  "customExpirationDate": "2025-07-11T00:45:11.517Z"
}
```

**Responses**

<table><thead><tr><th width="90.4444580078125">Code</th><th width="506.3333740234375">Description</th><th width="71.22216796875">Links</th></tr></thead><tbody><tr><td>201</td><td>Membro adicionado na turma com sucesso!</td><td><em>No links</em></td></tr><tr><td>400</td><td><p>Paramêtros obrigatórios não foram informados</p><p></p><p>Media type</p><p></p><p><code>application/json</code></p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

<details>

<summary>GET / groups / {groupId} / members - Listar todos os membros de uma turma</summary>

**Parameters**

| Name                                         | Description  |
| -------------------------------------------- | ------------ |
| <p>groupId \*</p><p>string</p><p>(path)</p>  | groupId      |
| <p>limit</p><p>number</p><p>(query)</p>      | limit        |
| <p>offset</p><p>number</p><p>(query)</p>     | offset       |
| <p>enteredSince</p><p>date</p><p>(query)</p> | enteredSince |
| <p>enteredUntil</p><p>date</p><p>(query)</p> | enteredUntil |
| <p>expiresSince</p><p>date</p><p>(query)</p> | expiresSince |
| <p>expiresUntil</p><p>date</p><p>(query)</p> | expiresUntil |

**Responses**

<table><thead><tr><th width="83.77783203125">Code</th><th width="514.77783203125">Description</th><th width="83.888671875">Links</th></tr></thead><tbody><tr><td>200</td><td><p>Listagem realizada com sucesso</p><p></p><p>Media type</p><p></p><p><code>application/json</code></p><p></p><ul><li>Example Value</li></ul><p></p><pre class="language-json"><code class="lang-json">{
  "data": [
    {
      "id": 0,
      "uuid": "string",
      "name": "string",
      "email": "string",
      "enteredAt": "2025-07-11T00:47:19.925Z",
      "expiresAt": "2025-07-11T00:47:19.925Z"
    }
  ],
  "metadata": {
    "totalCount": 0,
    "limit": 0,
    "offset": 0,
    "hasMore": true
  }
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

<details>

<summary>GET / groups / {uuid} - Buscar informações de um grupo por UUID</summary>

**Parameters**

| Name                              | Description |
| --------------------------------- | ----------- |
| <p>uuid \*</p><p>string(path)</p> | uuid        |

**Responses**

<table><thead><tr><th width="87.111083984375">Code</th><th width="521.6666259765625">Description</th><th width="64.77783203125">Links</th></tr></thead><tbody><tr><td>200</td><td><p>Grupo encontrado com sucesso</p><p></p><p>Media type</p><p></p><p><code>application/json</code></p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "id": 0,
  "uuid": "string",
  "name": "string",
  "description": "string",
  "enableCommunity": true,
  "enableMembersMural": true,
  "expirationType": "string",
  "expiresAt": "2025-07-11T00:52:51.913Z",
  "expirationInterval": 0,
  "isActive": true,
  "createdAt": "2025-07-11T00:52:51.913Z",
  "updatedAt": "2025-07-11T00:52:51.913Z",
  "membersCount": 0
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

<details>

<summary>GET / groups - Listar todas as turmas da plataforma</summary>

**Parameters**

| Name                                                              | Description                     |
| ----------------------------------------------------------------- | ------------------------------- |
| <p>limit</p><p>number</p><p>(query)</p>                           | limit                           |
| <p>offset</p><p>number</p><p>(query)</p>                          | offset                          |
| <p>takeGroupsThatMemberIsNotInById</p><p>number</p><p>(query)</p> | takeGroupsThatMemberIsNotInById |

**Responses**

<table><thead><tr><th width="85.99993896484375">Code</th><th width="528.22216796875">Description</th><th width="62.4443359375">Links</th></tr></thead><tbody><tr><td>200</td><td><p>Listagem realizada com sucesso</p><p></p><p>Media type</p><p></p><p><code>application/json</code></p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "data": [
    {
      "id": 0,
      "uuid": "string",
      "name": "string",
      "email": "string",
      "enteredAt": "2025-07-11T00:55:01.316Z",
      "expiresAt": "2025-07-11T00:55:01.316Z"
    }
  ],
  "metadata": {
    "totalCount": 0,
    "limit": 0,
    "offset": 0,
    "hasMore": true
  }
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>

### Relatórios

<details>

<summary>GET / reports / access</summary>

**Parameters**

| Name                                     | Description                                                                                    |
| ---------------------------------------- | ---------------------------------------------------------------------------------------------- |
| <p>limit</p><p>number</p><p>(query)</p>  | Número de registros por página (max 100)                                    limit              |
| <p>offset</p><p>number</p><p>(query)</p> | Número de registros a serem ignorados                                 offset                   |
| <p>search</p><p>string</p><p>(query)</p> | Pesquisa por nome, email e IP                                                           search |

**Responses**

<table><thead><tr><th width="60.4444580078125">Code</th><th>Description</th><th width="61.7777099609375">Links</th></tr></thead><tbody><tr><td>200</td><td><p>Relatório de acessos gerado com sucesso!</p><p></p><p>Media type</p><p></p><p><code>application/json</code></p><p></p><ul><li>Example Value</li></ul><pre class="language-json"><code class="lang-json">{
  "metadata": {
    "totalCount": 0,
    "hasMore": true,
    "limit": 0,
    "offset": 0
  },
  "data": {
    "id": 0,
    "uuid": "string",
    "name": "string",
    "email": "string",
    "enteredAt": "2025-07-11T01:00:47.269Z",
    "expiresAt": "2025-07-11T01:00:47.269Z"
  }
}
</code></pre></td><td><em>No links</em></td></tr></tbody></table>

</details>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.curseduca.com/curseduca-members.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.