Sign in

v1

latestOpenAPI 3.1.02026-07-264793109.1 KB
3. Sites

Get Sites

Retrieve sites, optionally filtering by MPAN or postcode.

Returns a page of sites with the total count and the requested subset of site records. Use the limit and offset parameters to navigate through pages of results.

get/entities/site

Query parameters

mpanstring

Filter sites by MPAN

Filter sites by MPAN

postcodestring

Filter sites by postcode

Filter sites by postcode

limitinteger

Maximum number of sites to return (1-5000)

Maximum number of sites to return (1-5000)

offsetinteger

Number of sites to skip for pagination

Number of sites to skip for pagination

Response

Successful Response

total_num_sitesinteger required

Total number of sites available

total_num_pagesinteger required

Total number of pages available

page_numberinteger required

Current page number (1-based)