Users

Base URL

All API requests should be made to:

Copyhttps://api.alpha1edtech.com

User Information

Get User Information

Retrieves user information based on their email address.

Endpoint: GET /users

Query Parameters:

• email (string, required): The email address of the user

Example Request:

httpCopyGET /[email protected]

Example Response:

jsonCopy[
  {
    "id": 3132,
    "status": "active",
    "dateLastModified": "2024-05-23T20:48:32.348Z",
    "metadata": {},
    "username": "johndoe123",
    "givenName": "John",
    "familyName": "Doe",
    "middleName": null,
    "preferredFirstName": "Johnny",
    "preferredMiddleName": null,
    "preferredLastName": "Doe-ness",
    "pronouns": "he/him",
    "email": "[email protected]",
    "sms": "1647291873",
    "phone": "1647291873",
    "agents": [],
    "grades": "6"
  }
]

Notes:

• The response is an array, but it will contain either 0 (if no match is found) or 1 (if a match is found) elements when filtering by email.

• Use this endpoint to obtain the user's ID, which is required for other user-specific endpoints.