Skip to main content

​
Overview

Returns comprehensive information about a specific school using its URN (Unique Reference Number). URNs are the official government identifiers for schools in the UK.

​
Path Parameters

ParameterTypeRequiredDescription
urnstringYesSchool URN (e.g., 100000)

​
Query Parameters

ParameterTypeRequiredDescription
expandstringNoComma-separated list of expansions: ratings, performance, catchment, demographics, finance

​
Response

The response structure is identical to the Get School by ID endpoint.

​
Example Requests

​
Basic Request

import { Vepler } from '@vepler/sdk';

const vepler = new Vepler({ apiKey: process.env.VEPLER_API_KEY });

const school = await vepler.schools.getByUrn('100000');

console.log(school.name);
console.log(`School ID: ${school.id}`);

​
With Expansions

const school = await vepler.schools.getByUrn('100000', {
  expand: 'ratings,performance,demographics'
});

​
URN vs School ID

IdentifierFormatDescriptionExample
URN6-digit numberOfficial government identifier100000
School IDPrefixed stringVepler’s internal identifiersch_abc123
Use URNs when integrating with government data sources or when users provide official school identifiers. Use Vepler School IDs for internal consistency across your application.