Skip to main content

Get List

GET 
/api/students

API Endpoint: Retrieve Students​

This endpoint allows you to retrieve a list of students from the UdyogX application. It is useful for obtaining student data for various purposes, such as displaying on a dashboard or for administrative tasks.

Request​

  • Method: GET
  • URL: https://app.udyogx.in/api/students

Response​

Upon a successful request, the response will contain a JSON object with the following structure:

  • students: An array of student objects, where each object may include details such as:
    • id: Unique identifier for the student.
    • name: The name of the student.
    • email: The email address of the student.
    • enrollmentDate: The date the student was enrolled.
    • Additional relevant fields that provide more context about each student.

Example Response​

{
	"students": [
		{
			"id": "123",
			"name": "John Doe",
			"email": "john.doe@example.com",
			"enrollmentDate": "2023-01-15"
		},
		{
			"id": "124",
			"name": "Jane Smith",
			"email": "jane.smith@example.com",
			"enrollmentDate": "2023-02-20"
		}
	]
}

Notes​

  • Ensure that you have the necessary permissions to access this endpoint.
  • The response will return an empty array if no students are found.

Responses​