GET
/
api
/
v1
/
users
curl --request GET \
  --url https://memberkit.com.br/api/v1/users
[
  {
    "id": 123,
    "full_name": "<string>",
    "email": "jsmith@example.com",
    "profile_image_url": "<string>",
    "sign_in_count": 123,
    "current_sign_in_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

​
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çãoAtributoTipo
Acesso ilimitadounlimitedboolean
Última vez vistolast_seen_atdatetime
ID do cursoenrollments.course_idinteger
ID da turmaenrollments.classroom_idinteger
Status da matrículaenrollments.statusstring
ID da assinaturamemberships.membership_level_idinteger
Status da assinaturamemberships.statusstring
ID do conviteinvite_passes.invite_idinteger
ID do certificadocertificates.certificate_template_idinteger

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)

Authorizations

​
api_key
string
query
required

Query Parameters

​
page
integer

Número da página.

​
query
string

Filtro para busca.

Response

200 - application/json
​
id
integer
required
​
full_name
string
required
​
email
string
required
​
profile_image_url
string | null
required
​
sign_in_count
integer
required
​
current_sign_in_at
string | null
required
​
created_at
string
required
​
updated_at
string
required

Was this page helpful?