List Products

Retrieve Jodo products associated with a student, optionally filtered by product type.

Endpoint

GET /api/v1/integrations/erp/students/:jodo_student_id/products

Request

curl -X GET 'https://[base_url]/api/v1/integrations/erp/students/:jodo_student_id/products?product_type=flex' \
  --header 'Authorization: Basic <token>' \
  --header 'Content-Type: application/json'

Path Parameters

Parameter	Type	Required	Description
jodo_student_id	string	Yes	Jodo student ID for which products should be listed.

Query Parameters

Parameter	Type	Required	Description
product_type	string	No	Optional product filter. Possible values: flex, pay, cred.

Response

HTTP 200

{
  "status": "success",
  "data": [
    {
      "id": 910,
      "product_type": "flex",
      "status": "pending"
    }
  ]
}

Response Data

Field	Type	Description
data[].id	number	Product record identifier.
data[].product_type	string	Product type, such as flex, pay, or cred.
data[].status	string	Current product status for the student.