Users
Lista membros
Users
Lista membros
Retorna uma lista de membros.
GET
/
api
/
v1
/
users
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 |
| 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 |
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:
Authorizations
api_key
string
queryrequiredQuery Parameters
page
integer
Número da página.
query
string
Filtro para busca.
Response
200 - application/json
id
integer
requiredfull_name
string
requiredemail
string
requiredprofile_image_url
string | null
requiredsign_in_count
integer
requiredcurrent_sign_in_at
string | null
requiredcreated_at
string
requiredupdated_at
string
requiredWas this page helpful?