List students by phone number

Returns all students linked to a given phone number across all schools.

GET /api/v1/chatbot/students

List students by phone number

cURL

curl --request GET \
  --url https://api.example.com/api/v1/chatbot/students/ \
  --header 'Authorization: Bearer <token>'

200

{}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-KEY · string

API Key for authentication (alternative to session auth).

Example:

"sk_..."

X-Schema-Name · string

School (tenant) identifier. Must match your account unless you have platform-wide access.

Query Parameters

phone_number · string · required

Phone number to search for students (international format)

Response

200

application/json

{key} · any