List students

GET/usuario

Lists every student of the school, ordered by ID, 150 per page.

AuthorizationBearer <token>

The school API key, found in the dashboard settings, sent in the Authorization header. The Bearer prefix is optional.

In: header

Query Parameters

cursor?string

Opaque page cursor. Do not build it: follow next_page_url and prev_page_url from the previous page.

Response Body

application/json

application/json

curl -X GET "https://example.com/usuario"
{  "code": 200,  "success": true,  "data": {    "paginator": {      "next_page_url": "http://example.com",      "perPage": 0,      "prev_page_url": "http://example.com"    },    "usuario": [      {        "cargo": "string",        "celular": "string",        "comecou_em": "2019-08-24T14:15:22Z",        "criado_em": "2019-08-24T14:15:22Z",        "doc": "string",        "email": "string",        "gratis": true,        "id": 0,        "login_auto": "http://example.com",        "login_crstk": "string",        "nome": "string",        "nome_empresa": "string",        "pontos": 0,        "tamanho_empresa": "string",        "ultimo_acesso_em": "2019-08-24T14:15:22Z",        "utm": {          "adcampaign": "string",          "adid": "string",          "fbclid": "string",          "gclid": "string",          "groupid": "string",          "page_name": "string",          "utm_content": "string",          "utm_medium": "string",          "utm_source": "string",          "utm_term": "string"        }      }    ]  }}