# Curseduca Members ### Membros
GET / members / by - Listar membros por campo **Parameters** | Name | Description | | --------------------------------------- | ----------- | |

email

string

(query)

| email | **Responses**
CodeDescriptionLinks
200

Membros listados com sucesso.

Media type:

application/json

  • Example Value
{
  "id": 0,
  "name": "string",
  "email": "string",
  "image": "string",
  "lastLogin": "2025-07-10T20:59:30.314Z"
}
No links
400

Requisição inválida, query não fornecida

Media type:

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
401

API Key inválida

Media type:

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
GET / members / {id} - Listar as informações de um membro **Parameters** | Name | Description | | ------------------------------- | ----------- | |

id \*

string(path)

| id | **Responses**
CodeDescriptionLinks
200

Membro encontrado com sucesso.

Media type:

application/json

  • Example Value
{
  "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"
}
No links
PATCH / members / {id} - Atualizar as informações de um membro **Parameters** | Name | Description | | ------------------------------- | ----------- | |

id \*

string(path)

| id | **Request body** `application/json` * Example Value ```json { "name": "string", "email": "string", "document": "string" } ``` **Responses**
CodeDescriptionLinks
200Membro atualizado com sucesso!No links
401

API Key inválida

Media type:

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
403

Acesso negado, token de acesso inválido

Media type:

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
404

Membro não encontrado.

Media type:

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
GET / members / {id} / address - Retorna o endereço de um membro **Parameters** | Name | Description | | ------------------------------- | ----------- | |

id \*

string(path)

| id | **Responses**
CodeDescriptionLinks
200

Membros listados com sucesso.

Media type:

application/json

  • Example Value
{
  "id": 0,
  "memberId": 0,
  "number": "string",
  "complement": "string",
  "street": "string",
  "neighborhood": "string",
  "city": "string",
  "state": "string",
  "country": "string",
  "zipcode": "string",
  "latitude": "string",
  "longitude": "string"
}
No links
GET / members - Listar todos os membros **Parameters** | Name | Description | | ------------------------------------------------------------ | ----------------------------------------------------- | |

limit

number

(query)

| limit | |

offset

number

(query)

| offset | |

startCreatedAt

string($date-time)

(query)

| startCreatedAt | |

endCreatedAt

string($date-time)

(query)

| endCreatedAt | |

startUpdatedAt

string($date-time)

(query)

| startUpdatedAt | |

endUpdatedAt

string($date-time)

(query)

| endUpdatedAt | |

groupId

string

(query)

| groupId | |

neverLogged

string

(query)

|

Available values : true, false

| **Responses**
CodeDescriptionLinks
200

Membros listados com sucesso.

Media type:

application/json

  • Example Value
{
  "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"
        }
      ]
    }
  ]
}
No links
PATCH /members - Atualizar as informações de um membro **Parameters** No parameters **Responses**
CodeDescriptionLinks
200Membro atualizado com sucesso!No links
401

API Key inválida

Media type:

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
403

Acesso negado, token de acesso inválido

Media type:

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
404

Membro não encontrado.

Media type:

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
POST / members - Cadastrar um novo usuário com funções administrativas **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**
CodeDescriptionLinks
201

Membro criado com sucesso!

Media type:

application/json

  • Example Value
{
  "id": 0,
  "uuid": "string",
  "email": "string",
  "links": [
    {
      "type": "string",
      "rel": "PASSWORD_DEFINITION_INTERFACE",
      "link": "string"
    }
  ]
}
No links
400

Paramêtros obrigatórios faltando

Media type:

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
401

API Key inválida

Media type:

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
POST / members / tenants - Adicionar membro em subplataforma. **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* |
### Default
GET / member-current-login **Parameters** No parameters **Responses** | Code | Description | Links | | ---- | ----------- | ---------- | | 200 | | *No links* |
GET / verify-member-access-to-community **Parameters** No parameters **Responses** | Code | Description | Links | | ---- | ----------- | ---------- | | 200 | | *No links* |
GET /verify-member-access-to-mural **Parameters** No parameters **Responses** | Code | Description | Links | | ---- | ----------- | ---------- | | 200 | | *No links* |
POST / onboarding / done **Parameters** No parameters **Responses** | Code | Description | Links | | ---- | ----------- | ---------- | | 201 | | *No links* |
GET / reports / groups **Parameters** No parameters **Responses** | Code | Description | Links | | ---- | ----------- | ---------- | | 200 | | *No links* |
GET / reports / group / contents **Parameters** No parameters **Responses** | Code | Description | Links | | ---- | ----------- | ---------- | | 200 | | *No links* |
GET / reports / group / channels **Parameters** No parameters **Responses** | Code | Description | Links | | ---- | ----------- | ---------- | | 200 | | *No links* |
GET / reports / group / members **Parameters** No parameters **Responses** | Code | Description | Links | | ---- | ----------- | ---------- | | 200 | | *No links* |
GET / reports / group / integrations **Parameters** No parameters **Responses** | Code | Description | Links | | ---- | ----------- | ---------- | | 200 | | *No links* |
GET / hc **Parameters** No parameters **Responses** | Code | Description | Links | | ---- | ----------- | ---------- | | 200 | | *No links* |
PATCH / inactivate-member **Parameters** No parameters **Responses** | Code | Description | Links | | ---- | ----------- | ---------- | | 200 | | *No links* |
PATCH / reactivate-member **Parameters** No parameters **Responses** | Code | Description | Links | | ---- | ----------- | ---------- | | 200 | | *No links* |
POST / me / mark-access **Parameters** No parameters **Responses** | Code | Description | Links | | ---- | ----------- | ---------- | | 201 | | *No links* |
GET / reports / tags **Parameters** No parameters **Responses** | Code | Description | Links | | ---- | ----------- | ---------- | | 200 | | *No links* |
GET / search / admin **Parameters** | Name | Description | | ------------------------------------ | ----------- | |

search \*

string(query)

| search | |

limit \*

string(query)

| limit | |

entity \*

string(query)

| entity | **Responses** | Code | Description | Links | | ---- | ----------- | ---------- | | 200 | | *No links* |
### Ações do membro #### Autenticação
PATCH / password - Alterar a senha do membro **Parameters** No parameters **Request body** `application/json` * Example Value ```json { "oldPassword": "string", "newPassword": "string" } ``` **Responses**
CodeDescriptionLinks
200

Senha alterada com sucesso!

Media type:

application/json

  • Example Value
{
  "id": 0
}
No links
400

Paramêtros obrigatórios faltando

Media type:

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
401

API Key inválida

Media type:

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
403

Acesso negado, credenciais inválidas

Media type:

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
POST/password/forgot - Esqueci minha senha **Parameters** No parameters **Request body** `application/json` * Example Value ```json { "username": "string" } ``` **Responses**
CodeDescriptionLinks
201Operação executada com sucesso. Também retornado caso o usuário não exista.No links
400

Email inválido.

Media type:

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
POST /login - Retornar as credenciais de login **Parameters** | Name | Description | | ------------------------------------------------ | ----------- | |

redirectUrl \*

string

(query)

| redirectUrl | **Request body** `application/json` * Example Value ```json { "username": "string", "password": "string", "device": { "app": { "uuid": "string" }, "device": "string", "registrationToken": "string" }, "accessTokenValidity": "string" } ``` **Responses**
CodeDescriptionLinks
201

Membro logado com sucesso!

Media type:

application/json

  • Example Value
{
  "accessToken": "string",
  "refreshToken": "string",
  "expiresAt": "2025-07-10T22:50:58.774Z",
  "redirectUrl": "string"
}
No links
400

Paramêtros obrigatórios faltando

Media type:

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
401

API Key inválida

Media type:

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
POST / refresh - Gerar novo token de acesso **Parameters** No parameters **Request body** `application/json` * Example Value ```json { "refreshToken": "string", "device": { "app": { "uuid": "string" }, "device": "string", "registrationToken": "string" } } ``` **Responses**
CodeDescriptionLinks
201

Token gerado com sucesso!

Media type:

application/json

  • Example Value
{
  "accessToken": "string",
  "expiresAt": "2025-07-11T00:18:43.866Z"
}
No links
401

Token inválido

Media type:

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
POST /register - Cadastrar um novo usuário **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**
CodeDescriptionLinks
201

Membro criado com sucesso!

Media type:

application/json

  • Example Value
{
  "id": 0
}
No links
400

Paramêtros obrigatórios faltando

Media type

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
401

API Key inválida

Media type

application/json

  • Example Value

{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
409

E-mail já cadastrado

Media type

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
#### Perfil
POST /me / fields - Criar um novo campo **Parameters** No parameters **Request body** `application/json` * Example Value ```json { "fieldSchema": { "id": 0 }, "value": "string" } ``` **Responses**
CodeDescriptionLinks
201Campo criado com sucesso!No links
401

API Key inválida

Media type

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
403

Acesso negado, token de acesso inválido

Media type

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
404

Membro ou modelo de campo não encontrado.

Media typeapplication/json

  • Media type

    application/json

    • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
PATCH / me - Atualizar membro **Parameters** No parameters **Request body** `application/json` * Example Value ```json { "name": "string", "email": "string", "document": "string" } ``` **Responses**
CodeDescriptionLinks
200Membro atualizado com sucesso!No links
401

API Key inválida

Media type

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
403

Acesso negado, token de acesso inválido

Media type

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
404

Membro não encontrado.

Media type

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
DELETE / me - Inativar membro **Parameters** No parameters **Responses**
CodeDescriptionLinks
200Membro inativado com sucesso!No links
401

API Key inválida

Media type

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
403

Acesso negado, token de acesso inválido

Media type

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
404

Membro não encontrado.

Media type

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
GET / me **Parameters** | Name | Description | | --------------------------------------- | ----------- | |

skipCache \*

string(query)

| skipCache | **Responses**
CodeDescriptionLinks
200

Membro encontrado com sucesso!

Media type

application/json

  • Example Value
{
  "uuid": "string",
  "id": 0,
  "name": "string",
  "email": "string",
  "image": "string",
  "termsOfUse": {
    "status": "SIGNED",
    "title": "string",
    "file": "string"
  },
  "slug": "string",
  "headline": "string"
}
No links
### Deep Links
POST / members / groups - Cadastrar membro em um grupo **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**
CodeDescriptionLinks
201Membro adicionado na turma com sucesso!No links
400

Paramêtros obrigatórios não foram informados

Media type

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
POST / members / groups / test **Parameters** No parameters **Request body** `application/json` * Example Value ```json {} ``` **Responses**
CodeDescriptionLinks
201No links
DELETE / members / {member} / groups / {groupId} - Remover membro de um grupo **Parameters** | Name | Description | | ------------------------------------------- | ----------- | |

member \*

number

(path)

| member | |

groupId \*

number

(path)

| groupId | **Responses**
CodeDescriptionLinks
201Membro removido da turma com sucesso!No links
400

Paramêtros obrigatórios não foram informados

Media type

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
POST/members/groups/batch - Cadastrar membro em um grupo **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**
CodeDescriptionLinks
201Membro adicionado na turma com sucesso!No links
400

Paramêtros obrigatórios não foram informados

Media type

application/json

  • Example Value
{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}
No links
GET / groups / {groupId} / members - Listar todos os membros de uma turma **Parameters** | Name | Description | | -------------------------------------------- | ------------ | |

groupId \*

string

(path)

| groupId | |

limit

number

(query)

| limit | |

offset

number

(query)

| offset | |

enteredSince

date

(query)

| enteredSince | |

enteredUntil

date

(query)

| enteredUntil | |

expiresSince

date

(query)

| expiresSince | |

expiresUntil

date

(query)

| expiresUntil | **Responses**
CodeDescriptionLinks
200

Listagem realizada com sucesso

Media type

application/json

  • Example Value

{
  "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
  }
}
No links
GET / groups / {uuid} - Buscar informações de um grupo por UUID **Parameters** | Name | Description | | --------------------------------- | ----------- | |

uuid \*

string(path)

| uuid | **Responses**
CodeDescriptionLinks
200

Grupo encontrado com sucesso

Media type

application/json

  • Example Value
{
  "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
}
No links
GET / groups - Listar todas as turmas da plataforma **Parameters** | Name | Description | | ----------------------------------------------------------------- | ------------------------------- | |

limit

number

(query)

| limit | |

offset

number

(query)

| offset | |

takeGroupsThatMemberIsNotInById

number

(query)

| takeGroupsThatMemberIsNotInById | **Responses**
CodeDescriptionLinks
200

Listagem realizada com sucesso

Media type

application/json

  • Example Value
{
  "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
  }
}
No links
### Relatórios
GET / reports / access **Parameters** | Name | Description | | ---------------------------------------- | ---------------------------------------------------------------------------------------------- | |

limit

number

(query)

| Número de registros por página (max 100) limit | |

offset

number

(query)

| Número de registros a serem ignorados offset | |

search

string

(query)

| Pesquisa por nome, email e IP search | **Responses**
CodeDescriptionLinks
200

Relatório de acessos gerado com sucesso!

Media type

application/json

  • Example Value
{
  "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"
  }
}
No links