Whitespace APIs
  1. Lookups
Whitespace APIs
  • Home
    • Welcome to the Whitespace API Developer Portal
  • Municipal REST
    • Municipal
      • Get resources for this service.
      • call the AddAoMRoundLogs operation.
      • call the AddAoMWorksheetLogs operation.
      • call the AddSiteAttachment operation.
      • call the AddSiteContact operation.
      • call the AddSiteLog operation.
      • call the AddSiteServiceItem operation.
      • call the AddSiteServiceItemRoundSchedule operation.
      • call the AddSiteServiceNotification operation.
      • call the AddWorksheetAttachment operation.
      • call the AddWorksheetNotes operation.
      • call the CancelWorksheet operation.
      • call the CreateWorksheet operation.
      • call the DeleteSiteContact operation.
      • call the DeleteSiteServiceItem operation.
      • call the DeleteSiteServiceItemRoundSchedule operation.
      • call the GetAccountSiteId operation.
      • call the GetActiveAddresses operation.
      • call the GetAddresses operation.
      • call the GetAddressesByCoordinatesRadius operation.
      • call the GetCollectionByUprnAndDate operation.
      • call the GetCollectionByUprnAndDatePlus operation.
      • call the GetCollectionSlots operation.
      • call the GetFullSiteCollections operation.
      • call the GetFullWorksheetDetails operation.
      • call the GetInCabLogs operation.
      • call the GetLogsSearch operation.
      • call the GetNotifications operation.
      • call the GetServices operation.
      • call the GetServiceItems operation.
      • call the GetSites operation.
      • call the GetSiteAttachments operation.
      • call the GetSiteAvailableRounds operation.
      • call the GetSiteCollections operation.
      • call the GetSiteCollectionExtraDetails operation.
      • call the GetSiteContacts operation.
      • call the GetSiteContracts operation.
      • call the GetSiteFlags operation.
      • call the GetSiteId operation.
      • call the GetSiteIncidents operation.
      • call the GetSiteInfo operation.
      • call the GetSiteLogs operation.
      • call the GetSiteNotifications operation.
      • call the GetSiteServiceItemRoundSchedules operation.
      • call the GetSiteWorksheets operation.
      • call the GetStreets operation.
      • call the GetWalkNumbers operation.
      • call the GetWorkflowStatusAndEvents operation.
      • call the GetWorksheetsByReference operation.
      • call the GetWorksheetAttachments operation.
      • call the GetWorksheetChargeMatrix operation.
      • call the GetWorksheetDetails operation.
      • call the GetWorksheetDetailEvents operation.
      • call the GetWorksheetDetailExtraInfoFields operation.
      • call the GetWorksheetDetailNotes operation.
      • call the GetWorksheetDetailServiceItems operation.
      • call the GetWorksheetExtraInfoFields operation.
      • call the GetWorksheetRoles operation.
      • call the GetWorksheetServiceItems operation.
      • call the HelloWorld operation.
      • call the ProgressWorkflow operation.
      • call the RaiseCancelWorksheetRequest operation.
      • call the UpdateSiteContact operation.
      • call the UpdateSiteServiceItem operation.
      • call the UpdateSiteServiceNotification operation.
      • call the UpdateWorkflowEventDate operation.
      • call the UpdateWorksheet operation.
  • Commercial REST
    • Contracts
      • get all contracts
      • Create Contract
      • get single contract
      • Ends a specific contract
      • Cancels a specific contract
      • Assign site services
      • Get all contract documents
      • Get all Collections by Contract
      • Upload a document for a given contract
      • Get Collection by id
      • Get the next available actions for a contract
      • Progress workflow associated with contract
    • Accounts
      • Get accounts - TBC
      • Create Account
      • Get account by Id
      • Update Account
      • Get all Sites belonging to account
      • Get all adhoc requests at account
      • Get all documents for an account
      • Get all Contracts by Account
    • Lookups
      • Get addresses
        GET
      • Get all SIC codes
        GET
      • Get all trading classifications
        GET
      • Gets all valid unit prices
        GET
      • Gets all valid adhoc unit prices
        GET
      • Get all Authorities
        GET
    • Sites
      • Get Site by id
      • Update Site
      • Get all adhoc requests at Site
      • Get all Contracts by Site
      • Get available collections days by site and waste stream
      • Get Site Contacts
      • Get Site Contact
      • Update Site Contacts
      • Create Site
      • Create Site Contact
      • Delete Site Contact
      • Get all contract discounts at the given site
      • Create a discount
      • Get a specific contract discount
      • Set end date for a contract discount
      • Delete a discount
      • Get specific adhoc discount at the given site
      • Get all adhoc discounts at the site
      • Create an adhoc discount
      • Set end date for an adhoc discount
      • Delete an adhoc discount
    • Worksheets
      • Create adhoc request
      • Get adhoc request by Id
      • Get adhoc request actions
      • Get all ad hoc request documents
      • Progress adhoc request actions
      • Upload a document for a given adhoc request
    • Waste Streams
      • Get all contract classification subtypes
      • Get all waste streams
      • Get all waste stream unit prices
      • Get all waste stream adhoc prices
      • Get all waste stream adhoc prices
      • Get all contract classifications
      • Get all payment methods
      • Get all collection items
      • Get all collection items
      • Get all payment frequencies
    • Adhoc Services
      • Gets all adhoc price classifications
      • Gets all adhoc services
      • Gets all adhoc items for a service
    • Collections
      • Assign site services
      • Get Collection by id
    • Discounts
      • Gets all contracts where a discount is applied
    • Documents
      • Gets a document
      • Delete a document Copy
      • Update a document
  1. Lookups

Get addresses

GET
/v1/addresses
LookupsAddresses
OperationId:Addresses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/addresses?Postcode'
Response Response Example
200 - Example 1
[
    {
        "addressId": 0,
        "organisationName": "string",
        "prefix": "string",
        "name": "string",
        "number": "string",
        "address1": "string",
        "address2": "string",
        "town": "string",
        "city": "string",
        "county": "string",
        "country": "string",
        "postcode": "string",
        "uprn": "string",
        "fullAddress": "string"
    }
]

Request

Query Params
Postcode
string 
required
>= 3 characters<= 10 characters
StreetName
string 
optional
Number
string 
optional
BusinessName
string 
optional
BuildingName
string 
optional
<= 60 characters
MaxResults
integer 
optional
>= 1<= 100
Default:
100

Responses

🟢200OK
application/json
Returns the list of top 100 addresses filtered by the given criteria
Body
array of:
addressId
integer <int32>
read-onlyrequired
The unique identifier of the address object. This is an auto-incremented integer field.
organisationName
string  | null 
optional
The business name of the property identified by this address entry, e.g. "Whitespace Work Software". This field has a maximum length of 60 characters.
prefix
string  | null 
optional
The address prefix of the property identified by this address entry, e.g. "Unit 14". This field has a maximum length of 20 characters.
name
string  | null 
optional
The address name of the property identified by this address entry, e.g. "Riverside Court". This field has a maximum length of 60 characters.
number
string  | null 
optional
The address number of the property identified by this address entry, e.g. "1A-3A". This field has a maximum length of 50 characters.
address1
string  | null 
optional
The address substreet of the property identified by this address entry, e.g. "Ground floor". This field has a maximum length of 60 characters.
address2
string  | null 
optional
The street name of the property identified by this address entry, e.g. "Douglas Drive". This field has a maximum length of 60 characters.
town
string  | null 
optional
The town or village of the property identified by this address, e.g. "Godalming". This field has a maximum length of 50 characters.
city
string  | null 
optional
The city of the property identified by this address, e.g. "Woking". This field has a maximum length of 50 characters.
county
string  | null 
optional
The county of the property identified by this address, e.g. "Surrey". This field has a maximum length of 50 characters.
country
string  | null 
required
The country of the property identified by this address, e.g. "United Kingdom". This field has a maximum length of 30 characters.
postcode
string  | null 
optional
The postcode of the property identified by this address, e.g. "GU7 1JX". This field has a maximum length of 50 characters.
uprn
string  | null 
optional
The Unique Property Reference Number (UPRN) for the address as typically provided by the local council gazetteer, such as the LLPG.
fullAddress
string  | null 
optional
A comma-separated concatenation of the address fields, e.g. "Riverside Court, Douglas Drive, Godalming, Surrey, GU7 1JX".
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
Modified at 2025-06-19 07:14:18
Previous
Get all Contracts by Account
Next
Get all SIC codes
Built with