Skip to main content
GET
/
programs
/
{programId}
Get
curl --request GET \
  --url https://api.mapademics.com/v1/programs/{programId} \
  --header 'X-API-Key: <api-key>'
{
  "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"
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

programId
string
required

Unique identifier for the program

Response

Program retrieved successfully

id
string
required
organizationId
string
required
name
string
required
courses
object[]
required

Array of course profiles

courseOrder
string[]
required

Ordered array of course IDs for curriculum sequencing

derivedSocs
string[]
required

SOC codes derived from the CIP code

Example:
["15-1252", "15-1256"]
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
description
string | null
code
string | null
cipCode
string | null

CIP (Classification of Instructional Programs) code

deletedAt
string<date-time> | null