API v2 (2.0.0)ReferenceUsers

List the access entries of a student from a sale

GET/user/{identifier}/access/by_external_id/{external_id}

Lists the access entries of a student that came from a sale or subscription ID at the gateway.

AuthorizationBearer <token>

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

In: header

Path Parameters

identifier*string

The student: id:<ID>, email:<email> or doc:<document>. A plain value also works: a valid email is looked up by email, anything else by ID or document.

external_id*string

Sale ID or subscription ID at the gateway.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/user/string/access/by_external_id/string"
{  "code": 200,  "message": "string",  "profiler": [],  "success": true,  "version": 2,  "data": {    "entries": [      {        "active": true,        "created_at": {          "iso": "2019-08-24T14:15:22Z",          "unix": "string"        },        "delivery_id": 0,        "id": 0,        "recurrence_id": "string",        "transaction_id": "string"      }    ]  }}