Skip to main content
GET
/
reports
List
curl --request GET \
  --url https://api.mapademics.com/v1/reports \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "organizationId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "settings": {
        "reportType": "occupationCrosswalk",
        "courses": [
          "<string>"
        ],
        "jobs": [
          {
            "id": "15-1252",
            "lib": "soc"
          }
        ],
        "skills": [
          {
            "id": "<string>",
            "lib": "internal"
          }
        ],
        "grouping": "courses",
        "view": "<string>",
        "area": {
          "type": "national",
          "code": "<string>"
        },
        "version": 123
      },
      "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
Required range: x <= 100
offset
integer
default:0

Response

Reports retrieved successfully

data
object[]
pagination
object