Sites
Get all 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
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
Filter sites by MPAN
Filter sites by postcode
Maximum number of sites to return (1-5000)
Required range:
1 <= x <= 5000
Number of sites to skip for pagination
Required range:
x >= 0
Response
200
application/json
Successful Response
Paginated response for site listings.
List of sites for the current page
Response model for site information.
Total number of sites available
Total number of pages available
Current page number (1-based)