List publications

Lists details about publications with data available for querying.

The URL for this endpoint is:

GET https://dev.statistics.api.education.gov.uk/api/v{version}/publications

Parameters

Path parameters

The following parameters will need to be substituted into the URL path.

Parameter	Type	Required	Description
version	string	true	The requested API version Defaults to: 1.0

Query parameters

Parameter	Type	Required	Description
search	string	false	A search term to find matching publications. Validation constraints: Minimum length: 3
page	integer	false	The page of results to fetch. Defaults to: 1 Validation constraints: Format: int32 Minimum: 1
pageSize	integer	false	The maximum number of results per page. Defaults to: 20 Validation constraints: Format: int32 Minimum: 1 Maximum: 40

Example request

To illustrate how to use this API endpoint, we have provided some samples below in various languages.

cURL

curl -X GET https://dev.statistics.api.education.gov.uk/api/v{version}/publications

JavaScript

const url = 'https://dev.statistics.api.education.gov.uk/api/v{version}/publications';

const response = await fetch(url, {
  method: 'GET',
});

console.log(response.json());

Python

import requests

url = 'https://dev.statistics.api.education.gov.uk/api/v{version}/publications'

response = requests.get(url)

print(response.text)

R

library(httr)

url <- 'https://dev.statistics.api.education.gov.uk/api/v{version}/publications'

response <- httr::GET(url)

output <- content(response)

Responses

Status	Description	Media Type	Schema
200	The paginated list of publications	application/json	PublicationPaginatedListViewModel
400	Bad Request	application/json	ValidationProblemViewModel

Example successful response

{
  "paging": {
    "page": 1,
    "pageSize": 20,
    "totalResults": 60,
    "totalPages": 3
  },
  "results": [
    {
      "id": "d851c09e-7f5a-4750-9191-ed67ba5e8f8b",
      "title": "Pupil absence in schools in England",
      "slug": "pupil-absence-in-schools-in-england",
      "summary": "Summary of the publication.",
      "lastPublished": "2024-06-01T09:30:00+00:00"
    }
  ]
}