Overview

Read-only JSON endpoint that returns the prospects in your school with their status, source and linked student — the same records as the prospect list in the app.

To create a prospect rather than read one, see Prospect registration API.

Authentication

Authenticate with the school's API key. Pass it either way:

Header: X-API-KEY: <school_api_key>
Query:  ?apikey=<school_api_key>

The key identifies the school. Responses are automatically scoped to that school; there is no school_id parameter. We recommend the header form: keys passed in a URL can end up in server or proxy logs.

Endpoint

GET or POST /api/v1/prospect

The older path /globalApis/prospect_list still works and returns the same response.

Parameters are accepted in the query string or the request body, so either style works.

Parameters

Param	Type	Notes
`id`	integer	One prospect id. Omit → all prospects.
`search`	string	Matches name, email or phone number.
`per_page`	integer	Records per page. Default 20, maximum 100.
`page`	integer	Page number. Default 1.

Example

curl -H "X-API-KEY: YOUR_KEY" "https://app.teachngo.com/api/v1/prospect?per_page=50&search=doe"

Response

{
  "status": "success",
  "totalRecords": 57,
  "limit": 50,
  "page": 1,
  "totalPages": 2,
  "next": 2,
  "previous": null,
  "data": [
    {
      "id": 5001,
      "fname": "Jane",
      "lname": "Doe",
      "email_address": "jane@example.com",
      "mobile_phone": "871234567",
      "mobile_phone_international": "353871234567",
      "first_contact": "2026-07-20",
      "created": "2026-07-23 16:04:08",
      "modified": "2026-07-25 09:11:02",
      "source": "Website",
      "status": "New",
      "course_subject": "English",
      "course_level": "B1",
      "student_id": null,
      "custom_fields": {}
    }
  ]
}

Field reference

Field	Meaning
`id`	The prospect's Teach 'n Go id
`created`	When the prospect record was created
`modified`	When it was last changed
`first_contact`	The date your school first spoke to them, entered by hand — not the same as `created`
`status`	The prospect status name, for example `New` or `Enrolled`
`source`	The referral source name, `null` if none is set
`student_id`	The student this prospect became, once converted — `null` until then
`course_subject`, `course_level`	What the prospect enquired about, as free text
`availabilty`	When the prospect said they are free, as free text — note the field name is spelled this way
`description`	Free-text notes on the enquiry
`custom_fields`	Your school's custom fields, keyed by field name

There is no linked class id. A prospect records the subject and level enquired about as free text, not a reference to a specific class. Once a prospect is converted, use student_id with the student endpoint to find their enrolments.

Converted prospects

Converted prospects may disappear. If your school has Delete prospect when converted to student? switched on under Settings → School settings → Edit school in the Prospects tab, the prospect record is removed at conversion and will not appear here at all. With the setting off, the prospect stays and its student_id points at the new student.

Pagination and errors

The response wraps the records in totalRecords, limit, page, totalPages, next and previous. See API error codes and pagination.

Prospect List API