Whitespace APIs
  1. Accounts
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
        GET
      • Create Account
        POST
      • Get account by Id
        GET
      • Update Account
        PATCH
      • Get all Sites belonging to account
        GET
      • Get all adhoc requests at account
        GET
      • Get all documents for an account
        GET
      • Get all Contracts by Account
        GET
    • Lookups
      • Get addresses
      • Get all SIC codes
      • Get all trading classifications
      • Gets all valid unit prices
      • Gets all valid adhoc unit prices
      • Get all Authorities
    • 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. Accounts

Get accounts - TBC

GET
/v1/accounts
Accounts
TBC
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/accounts'
Response Response Example
200 - Example 1
[
    {
        "id": 0,
        "code": "AUT01",
        "fmsReference": "111111",
        "contactInfo": {
            "id": 0,
            "firstName": "string",
            "middleName": "string",
            "surname": "string",
            "email": "mrsasmith@emailprovider.com",
            "telephone": "0800111111",
            "mobile": "07777777777",
            "fullName": "Mrs A Smith",
            "mainContact": true
        },
        "address": {
            "organisationName": "string",
            "prefix": "string",
            "name": "string",
            "number": "string",
            "address1": "string",
            "address2": "string",
            "town": "string",
            "city": "string",
            "county": "string",
            "country": "string",
            "postcode": "string",
            "fullAddress": "string"
        }
    }
]

Request

Query Params
email
string 
optional
email
Example:
{{emailAddress}}
code
string 
optional
Example:
{{accountCode}}
name
string 
optional
name
Example:
{{accountName}}

Responses

🟢200OK
application/json
Body
array of:
id
integer 
read-onlyrequired
The unique identifier for the account as stored in the Whitespace database. This is an auto-incremented integer field.
code
string 
read-onlyrequired
The short code for the account as stored in the Whitespace database. This is auto-generated by the system based on the organisation name. This has a maximum length of 10 characters.
<= 10 characters
Example:
AUT01
fmsReference
string  | null 
optional
The FMS Reference field for the account as stored in the Whitespace database. This has a maximum length of 15 characters.
<= 15 characters
Example:
111111
contactInfo
object (ContactInfo) 
optional
The primary invoice contact information for the account.
id
integer 
required
The unique identifier for the contact as stored in the Whitespace database. This is an auto-incremented integer field.
firstName
string  | null 
optional
The contact's first name as stored in the Whitespace database. This has a maximum length of 30 characters.
<= 30 characters
middleName
string  | null 
optional
The contact's middle name as stored in the Whitespace database. This has a maximum length of 100 characters.
<= 100 characters
surname
string  | null 
optional
The contact's surname as stored in the Whitespace database. This has a maximum length of 30 characters.
<= 30 characters
email
string  | null 
optional
The contact's email address as stored in the Whitespace database. This has a maximum length of 70 characters.
<= 70 characters
Example:
mrsasmith@emailprovider.com
telephone
string  | null 
optional
The contact's telephone number as stored in the Whitespace database. This has a maximum length of 20 characters.
<= 12 characters
Example:
0800111111
mobile
string  | null 
optional
The contact's mobile number as stored in the Whitespace database. This has a maximum length of 20 characters.
<= 12 characters
Example:
07777777777
fullName
string 
optional
The contact's full name as stored in the Whitespace database. This has a maximum length of 50 characters.
<= 50 characters
Example:
Mrs A Smith
mainContact
boolean 
optional
This is a flag that determines whether this particular contract entry is the primary contact for the associated site or account. This is a boolean field.
address
object 
required
The address information for the account.
organisationName
string  | null 
optional
prefix
string  | null 
optional
name
string  | null 
optional
number
string  | null 
optional
address1
string  | null 
optional
address2
string  | null 
optional
town
string  | null 
optional
city
string  | null 
optional
county
string  | null 
optional
country
string  | null 
optional
postcode
string  | null 
optional
fullAddress
string  | null 
optional
🟠401Unauthorized
🟠403Forbidden
Modified at 2025-06-18 14:15:55
Previous
Progress workflow associated with contract
Next
Create Account
Built with