Skip to main content
GET
/
programs
List
curl --request GET \
  --url https://api.mapademics.com/v1/programs \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "organizationId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "code": "<string>",
      "cipCode": "<string>",
      "courses": [
        {
          "courseId": "<string>",
          "courseName": "<string>",
          "courseCode": "<string>",
          "courseDefaultSectionId": "<string>",
          "courseDisplayName": "<string>"
        }
      ],
      "courseOrder": [
        "<string>"
      ],
      "derivedSocs": [
        "15-1252",
        "15-1256"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123,
    "hasMore": true
  }
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Query Parameters

limit
integer
default:50

Number of items to return

Required range: x <= 100
offset
integer
default:0

Number of items to skip

Response

Programs retrieved successfully

data
object[]
pagination
object