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 all adhoc requests at account

GET
/v1/accounts/{id}/adhoc-requests
Accounts
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/accounts//adhoc-requests'
Response Response Example
200 - Example 1
[
    {
        "id": 0,
        "reference": "string",
        "site": {
            "id": 0,
            "organisationName": "string",
            "fullAddress": "string"
        },
        "status": {
            "id": 1,
            "name": "Active"
        },
        "adHocService": {
            "id": 1,
            "name": "Sack Sales Pre-Paid"
        },
        "adHocItems": [
            {
                "id": 1,
                "name": "SACK-50"
            }
        ],
        "extraInfoFields": [
            {
                "id": 1,
                "name": "On Stop Reason",
                "type": "1",
                "required": true,
                "value": "string"
            }
        ],
        "workflow": {
            "id": 0,
            "state": "Awaiting Confirmation",
            "nextActions": [
                "Confirm"
            ]
        },
        "createdDate": "2019-08-24T14:15:22Z",
        "startdate": "2019-08-24T14:15:22Z",
        "dueDate": "2019-08-24T14:15:22Z",
        "completedDate": "2019-08-24T14:15:22Z",
        "latitude": 0,
        "longitude": 0
    }
]

Request

Path Params
id
integer 
required

Responses

🟢200OK
application/json
Body
array of:
id
integer 
read-onlyrequired
The unique identifier for the ad hoc request as stored in the Whitespace database. This is an auto-incremented integer field.
reference
string  | null 
optional
The optional reference of the ad hoc request. This has a maximum length of 20 characters.
<= 20 characters
site
object 
required
The site details of ad hoc request.
id
integer 
required
The unique identifier of the Sites table. This is an auto-incrementing integer field.
organisationName
string  | null 
optional
The business name of the property identified by this site entry, e.g. "Whitespace Work Software". This field has a maximum length of 60 characters.
<= 60 characters
fullAddress
string  | null 
optional
A comma-separated concatenation of the site fields, e.g. "Riverside Court, Douglas Drive, Godalming, Surrey, GU7 1JX".
status
object (AdHocStatus) 
required
The status of the ad hoc request.
id
integer 
read-onlyrequired
The unique identifier for the site status as stored in the Whitespace database. This is an auto-incremented integer field.
Example:
1
name
string 
read-onlyoptional
The short name for the adhoc request status as stored in the Whitespace database. This has a maximum length of 50 characters.
<= 50 characters
Example:
Active
adHocService
object 
required
The ad hoc service behind the ad hoc request.
id
integer <int32>
read-onlyrequired
The unique identifier for the ad hoc service as stored in the Whitespace database. This is an auto-incremented integer field.
Example:
1
name
string 
required
The short name for the ad hoc service as stored in the Whitespace database. This has a maximum length of 50 characters.
<= 50 characters
Example:
Sack Sales Pre-Paid
adHocItems
array [object {2}] 
required
The ad hoc items assigned to the ad hoc request.
id
integer <int32>
read-onlyrequired
The unique identifier for the ad hoc item. This is an auto-incremented integer field.
Example:
1
name
string 
required
The short name of the ad hoc item. This has a maximum length of 50 characters.
<= 50 characters
Example:
SACK-50
extraInfoFields
array [object {5}] 
required
The extra info fields assigned to the ad hoc request.
id
integer 
Extra Info ID
required
The unique identifier for the extra info field as stored in the Whitespace database. This is an auto-incremented integer field.
Example:
1
name
string 
required
The short name of the extra info field. This has a maximum length of 50 characters.
<= 50 characters
Example:
On Stop Reason
type
enum<string> 
read-onlyrequired
Enum for available Extra Info types
Allowed values:
1234561718
Example:
String
required
boolean 
required
Identifies whether the extra info field is a required field or not. This is a boolean field.
value
string  | null 
optional
The value of the extra info field.
<= 2000 characters
workflow
object (Workflow) 
required
The workflow associated with the contract. The workflow is only active whilst the contract is in quotation status.
id
integer 
workflow instance ID
read-onlyrequired
The unique identifier for a particular instance of the workflow engine. This is an auto-incremented integer field.
state
string 
read-onlyoptional
The current state of the workflow. This has a maximum length of 50 characters.
<= 50 characters
Example:
Awaiting Confirmation
nextActions
array[string]
optional
A list of possible next actions from the current state of the workflow.
>= 0 items
createdDate
string <date-time>
required
The date the ad hoc request was created.
startdate
string <date-time>
required
The start date for the ad hoc request.
dueDate
string <date-time>
required
The due by date for the ad hoc request.
completedDate
string <date-time> | null 
optional
The date the ad hoc request was completed on.
latitude
number 
optional
The latitude of the ad hoc request.
longitude
number 
optional
The longitude of the ad hoc request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
Modified at 2025-06-19 07:14:18
Previous
Get all Sites belonging to account
Next
Get all documents for an account
Built with