Welcome to Government Purchase Orders API

1.a. API Reference

The Government Purchase Orders API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

BASE URL

https://government-purchase-orders-api.p.rapidapi.com
Go to top

1.b. Authentication

The Government Purchase Orders API uses API keys to authenticate requests. You can view and manage your API keys in the RapidAPI Dashboard.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

REQUEST

GET /purchase_orders/id/?token=rapidapi-02928-29292-2991AA02-292&id=1&fields=* HTTP/1.1
X-Rapidapi-Key: {X-Rapidapi-Key}
X-Rapidapi-Host: government-purchase-orders-api.p.rapidapi.com
Host: government-purchase-orders-api.p.rapidapi.com
Go to top

1.c. Errors

Government Purchase Orders API uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Government Purchase Orders API’s servers (these are rare).

Some 4xx errors that could be handled programmatically (e.g., a card is declined) include an error code that briefly explains the error reported.

Attributes

code string

For some errors that could be handled programmatically, a short string indicating the error code reported.

decline_code string

For card errors resulting from a card issuer decline, a short string indicating the card issuer’s reason for the decline if they provide one.

message string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

HTTP Status Code Summary

200	
OK
Everything worked as expected.

400	
Bad Request
The request was unacceptable, often due to missing a required parameter.

401	
Unauthorized
No valid API key provided.

402	
Request Failed
The parameters were valid but the request failed.

403	
Forbidden
The API key doesn’t have permissions to perform the request.

404	
Not Found
The requested resource doesn’t exist.

409	
Conflict
The request conflicts with another request (perhaps due to using the same idempotent key).

429	
Too Many Requests
Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.

500, 502, 503, 504	
Server Errors
Something went wrong on Stripe’s end. (These are rare.)
Go to top

1.d. Pagination

All top-level API resources have support for bulk fetches through “list” API methods. For example, you can list purchase orders, list organisations, and list suppliers. These list API methods share a common structure and accept, at a minimum, the following two parameters: limit and page.

Government Purchase Orders’s list API methods use cursor-based pagination through the page parameter. 

The limit parameter on the number of objects to return, ranging between 1 and 100.

Attributes

limit optional default is 10

This specifies a limit on the number of objects to return, ranging between 1 and 100.

page optional default is 1

A cursor to use in pagination. This is a page number that defines your place in the list. For example, if you make a list request for page 10 and receive 25 objects, this points the start of the list to page 10 and then it returns the next 25 objects in the list.

RESPONSE

{
  "status": "success",
  "code": 200,
  "message": "OK. Everything worked as expected.",
  "result": {
    "object": "list",
    "data": [
      {
        "name": "3e8e97e78239d166191aee72eb49e55f",
        "id": "1",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "RG Carter Southern Ltd",
        "account_type": "Capital Expenditure",
        "cost_centre": "Balance Sheet",
        "description": "Mildenhall Hub - Payment Certificate",
        "amount": "390725",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "3e8e97e78239d166191aee72eb49e55f",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050488",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "a86a8ea28d493dc9863cdb4dfe2e9918"
      },
      {
        "name": "407dbc3a2fdb7f69e94736378f2416f5",
        "id": "2",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Local Government Association",
        "account_type": "Subscriptions",
        "cost_centre": "Corporate Expenditure",
        "description": "LGA Membership Subscription",
        "amount": "10450",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "407dbc3a2fdb7f69e94736378f2416f5",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8051073",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "cf8159e706828b60449192be2c998b1e"
      },
      {
        "name": "3d304776301b1bf7c5863fd5b6714d75",
        "id": "3",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Cale Access UK Ltd",
        "account_type": "TPP - Other",
        "cost_centre": "Off Street Car Parks",
        "description": "MP104 to CWT-C Upgrade",
        "amount": "9032",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "3d304776301b1bf7c5863fd5b6714d75",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050360",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "8ae1369f29aea431ad5eb0277991bb7c"
      },
      {
        "name": "31c2ee04b5cc16d3e8408eeebd4f8627",
        "id": "4",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Cobalt Telephone Technologies Ltd",
        "account_type": "Services - Fees and Charges",
        "cost_centre": "Off Street Car Parks",
        "description": "SEBC RingGo Fee",
        "amount": "7132.98",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "31c2ee04b5cc16d3e8408eeebd4f8627",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050797",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "df415080e831ac7f9138fbb1edc46393"
      },
      {
        "name": "5210274d952c1be5f6b7cf152a08b2d4",
        "id": "5",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Truetech Integrated Ltd",
        "account_type": "TPP - Other",
        "cost_centre": "Off Street Car Parks",
        "description": "Body Cameras",
        "amount": "7432.8",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "5210274d952c1be5f6b7cf152a08b2d4",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050963",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "de8fdd823ae9f427a1ece1c63ee18c37"
      },
      {
        "name": "c42b9cc8d1bf66b04c40d00724f3f2d6",
        "id": "6",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Modern Mindset Ltd",
        "account_type": "Computing - Purchase of Hardware",
        "cost_centre": "Democratic Services",
        "description": "modern.gov",
        "amount": "10250",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "c42b9cc8d1bf66b04c40d00724f3f2d6",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050436",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "1ee2fdd8b560bbcfa7927d30d52587f5"
      },
      {
        "name": "4495daae0c1033ae1658447b05ebd420",
        "id": "7",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Greencells GmbH",
        "account_type": "R & M of Plant & Equipment",
        "cost_centre": "Solar Farm",
        "description": "R & M of Plant & Equipment",
        "amount": "5290",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "4495daae0c1033ae1658447b05ebd420",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050649",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "ba6f1610d572201a8c0d3520b0c591ec"
      },
      {
        "name": "5e47087640d45414a3148016e5d37143",
        "id": "8",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "United Stage International Limited",
        "account_type": "Artistes/Performers Fees",
        "cost_centre": "Bury Festival",
        "description": "Artiste Fees",
        "amount": "8000",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "5e47087640d45414a3148016e5d37143",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050952",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "0b6efc158a700a107b01ca2ed68121d0"
      },
      {
        "name": "4ccd8c159cec5cc848b32795b97b1a73",
        "id": "9",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Hazard Chase Limited",
        "account_type": "Artistes/Performers Fees",
        "cost_centre": "Bury Festival",
        "description": "Artiste Fees",
        "amount": "7850",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "4ccd8c159cec5cc848b32795b97b1a73",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050955",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "a70a522bdc27065bfa4aceaa73cdaa6f"
      },
      {
        "name": "02c38584d5312d2deaf4bb95ae68a86a",
        "id": "10",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "WFL (UK) Ltd t/a Hall Fuels",
        "account_type": "Stock - For Internal Use",
        "cost_centre": "Balance Sheet",
        "description": "Fuel for BSE",
        "amount": "14278.22",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "02c38584d5312d2deaf4bb95ae68a86a",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050633",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "1693e2b09d4ceddd19873d51930bc684"
      }
    ],
    "pagination": {
      "total_records": "417",
      "current_page": 1,
      "next_page": 2,
      "previous_page": false,
      "records_per_page": "10",
      "total_pages": 42
    },
    "query": {
      "fields": "*",
      "filters": [],
      "limit": "10",
      "offset": 0,
      "dataset": "government_purchase_orders",
      "order_by": "id",
      "group_by": "id"
    }
  }
}
Go to top

1.e. Search

Some top-level API resource have support for retrieval via “search” API methods. For example, you can search purchase orders, search suppliers, and search organisations.

Government Purchase Orders’s search API methods utilize cursor-based pagination via the page request parameter and next_page response parameter. For example, if you make a search request and receive "next_page": "pagination_key" in the response, your subsequent call can include page=pagination_key to fetch the next page of results.

Attributes

limit optional default is 10

This specifies a limit on the number of objects to return, ranging between 1 and 100.

page optional default is 1

A cursor to use in pagination. This is a page number that defines your place in the list. For example, if you make a list request for page 10 and receive 25 objects, this points the start of the list to page 10 and then it returns the next 25 objects in the list.

RESPONSE

{
  "status": "success",
  "code": 200,
  "message": "OK. Everything worked as expected.",
  "result": {
    "object": "search_result",
    "data": [
      {
        "organisation_name": "West Suffolk Council",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5"
      }
    ],
    "pagination": {
      "total_records": "1",
      "current_page": 1,
      "next_page": false,
      "previous_page": false,
      "records_per_page": "10",
      "total_pages": 1
    },
    "query": {
      "fields": "*, organisation_id",
      "query": "Suffolk",
      "filters": [],
      "limit": "10",
      "offset": 0,
      "dataset": "government_purchase_orders",
      "order_by": "district_name desc",
      "group_by": "organisation_id",
      "query_filters": [
        "organisation_name",
        "sovereign_state_name",
        "country_name",
        "region_name",
        "area_name",
        "county_name",
        "district_name",
        "organisation_id"
      ]
    }
  }
}
Go to top

1.f. Fields

All top-level API resources have support for bulk fetches through list and search API methods. For example, you can list purchase orders, list organisations, and list suppliers or you can search purchase orders, search organisations, and search suppliers. These list and search API methods share a common structure and accept a field selection that is returned by the API methods.

This means that you can customise to only have some of the available API resource fields returned within your API method response.

List and Search API methods come with a list of Available fields.

You can pass the fields parameter when making a request and then add a list of fields you want returned by the API response.

By default * (or star character) or all available fields are returned by the API endpoint request for the API resource.

But you can select which fields you want to be returned by for example passing:

fields=organisation_name,supplier_name,year,month,amount

This will only return the fields: organisation_name, supplier_name, year, month and amount.

Fields list parameter must be separated by a comma character ,.

Attributes

fields string example

Only return the Purchase Orders with the list of fields specified. Default is * or all available fields are returned.

Available fields list example

*, id, organisation_name, supplier_name, account_type, cost_centre, description, amount, year, month, source_name, source_url, licence_name, licence_url, guid, updated_date, created_date, month_name, order_number, sovereign_state_name, country_name, region_name, area_name, county_name, district_name, currency_symbol, organisation_address_line_1, organisation_address_line_2, organisation_town_city_name, organisation_county_name, organisation_region_name, organisation_postcode, organisation_country_name, organisation_sovereign_state_name, organisation_url, organisation_procurement_url, organisation_telephone_number, organisation_email_address, organisation_facebook_url, organisation_youtube_url, organisation_instagram_url, organisation_x_url, organisation_tiktok_url, organisation_linkedin_url, organisation_latitude, organisation_longitude, order_date, department_name, category_name, section_name, organisation_id, supplier_id

RESPONSE

{
  "status": "success",
  "code": 200,
  "message": "OK. Everything worked as expected.",
  "result": {
    "object": "list",
    "data": [
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "RG Carter Southern Ltd",
        "year": "2019",
        "month": "4",
        "amount": "390725"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Local Government Association",
        "year": "2019",
        "month": "4",
        "amount": "10450"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Cale Access UK Ltd",
        "year": "2019",
        "month": "4",
        "amount": "9032"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Cobalt Telephone Technologies Ltd",
        "year": "2019",
        "month": "4",
        "amount": "7132.98"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Truetech Integrated Ltd",
        "year": "2019",
        "month": "4",
        "amount": "7432.8"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Modern Mindset Ltd",
        "year": "2019",
        "month": "4",
        "amount": "10250"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Greencells GmbH",
        "year": "2019",
        "month": "4",
        "amount": "5290"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "United Stage International Limited",
        "year": "2019",
        "month": "4",
        "amount": "8000"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Hazard Chase Limited",
        "year": "2019",
        "month": "4",
        "amount": "7850"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "WFL (UK) Ltd t/a Hall Fuels",
        "year": "2019",
        "month": "4",
        "amount": "14278.22"
      }
    ],
    "pagination": {
      "total_records": "417",
      "current_page": 1,
      "next_page": 2,
      "previous_page": false,
      "records_per_page": "10",
      "total_pages": 42
    },
    "query": {
      "fields": "organisation_name,supplier_name,year,month,amount",
      "filters": [],
      "limit": "10",
      "offset": 0,
      "dataset": "government_purchase_orders",
      "order_by": "id",
      "group_by": "id"
    }
  }
}
Go to top

1.g. Ordering

You can specify the order of rows in your response using the order_by clause, which consists of one or more comma-separated sequences of: 

order_by={field_name} asc|desc

 If you do not specify asc or desc after a field name, the Government Purchase Orders API will default to asc.

You can also order rows by combining several fields together for example:

order_by={field_name_1} asc|desc,{field_name_2} asc|desc

 Each API resource list or search endpoints allows the ordering of rows.

They will also provide a list of all available fields that you can use to order rows by.

Attributes

order_by string example

Specify the ordering of rows in your response. By default rows are ordered by id.

Available fields list example

id, id asc, id desc, organisation_name, organisation_name asc, organisation_name desc, supplier_name, supplier_name asc, supplier_name desc, amount, amount asc, amount desc, account_type, account_type asc, account_type desc, cost_centre, cost_centre asc, cost_centre desc, year, year asc, year desc, month, month asc, month desc, order_date, order_date asc, order_date desc, order_number, order_number asc, order_number desc

RESPONSE

{
  "status": "success",
  "code": 200,
  "message": "OK. Everything worked as expected.",
  "result": {
    "object": "list",
    "data": [
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "RG Carter Southern Ltd",
        "year": "2019",
        "month": "4",
        "amount": "390725"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Local Government Association",
        "year": "2019",
        "month": "4",
        "amount": "10450"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Cale Access UK Ltd",
        "year": "2019",
        "month": "4",
        "amount": "9032"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Cobalt Telephone Technologies Ltd",
        "year": "2019",
        "month": "4",
        "amount": "7132.98"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Truetech Integrated Ltd",
        "year": "2019",
        "month": "4",
        "amount": "7432.8"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Modern Mindset Ltd",
        "year": "2019",
        "month": "4",
        "amount": "10250"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Greencells GmbH",
        "year": "2019",
        "month": "4",
        "amount": "5290"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "United Stage International Limited",
        "year": "2019",
        "month": "4",
        "amount": "8000"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Hazard Chase Limited",
        "year": "2019",
        "month": "4",
        "amount": "7850"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "WFL (UK) Ltd t/a Hall Fuels",
        "year": "2019",
        "month": "4",
        "amount": "14278.22"
      }
    ],
    "pagination": {
      "total_records": "417",
      "current_page": 1,
      "next_page": 2,
      "previous_page": false,
      "records_per_page": "10",
      "total_pages": 42
    },
    "query": {
      "fields": "organisation_name,supplier_name,year,month,amount",
      "filters": [],
      "limit": "10",
      "offset": 0,
      "dataset": "government_purchase_orders",
      "order_by": "id",
      "group_by": "id"
    }
  }
}
Go to top

1.h. Grouping

You can set the field names of the columns to group the results by using the group_by clause.

For example:

group_by=organisation_name

Multiple column names must be separated by comma.

If more than one column name is specified, returned records will be nested in the hierarchy of the specified columns. 

For example:

group_by=organisation_name,supplier_name

Attributes

grouping_by string example

Specify the grouping of rows in your response. By default rows are grouped by id.

Available fields list example

*, id, organisation_name, supplier_name, account_type, cost_centre, description, amount, year, month, source_name, source_url, licence_name, licence_url, guid, updated_date, created_date, month_name, order_number, sovereign_state_name, country_name, region_name, area_name, county_name, district_name, currency_symbol, organisation_address_line_1, organisation_address_line_2, organisation_town_city_name, organisation_county_name, organisation_region_name, organisation_postcode, organisation_country_name, organisation_sovereign_state_name, organisation_url, organisation_procurement_url, organisation_telephone_number, organisation_email_address, organisation_facebook_url, organisation_youtube_url, organisation_instagram_url, organisation_x_url, organisation_tiktok_url, organisation_linkedin_url, organisation_latitude, organisation_longitude, order_date, department_name, category_name, section_name, organisation_id, supplier_id

RESPONSE

{
  "status": "success",
  "code": 200,
  "message": "OK. Everything worked as expected.",
  "result": {
    "object": "list",
    "data": [
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "RG Carter Southern Ltd",
        "year": "2019",
        "month": "4",
        "amount": "390725"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Local Government Association",
        "year": "2019",
        "month": "4",
        "amount": "10450"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Cale Access UK Ltd",
        "year": "2019",
        "month": "4",
        "amount": "9032"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Cobalt Telephone Technologies Ltd",
        "year": "2019",
        "month": "4",
        "amount": "7132.98"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Truetech Integrated Ltd",
        "year": "2019",
        "month": "4",
        "amount": "7432.8"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Modern Mindset Ltd",
        "year": "2019",
        "month": "4",
        "amount": "10250"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Greencells GmbH",
        "year": "2019",
        "month": "4",
        "amount": "5290"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "United Stage International Limited",
        "year": "2019",
        "month": "4",
        "amount": "8000"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Hazard Chase Limited",
        "year": "2019",
        "month": "4",
        "amount": "7850"
      },
      {
        "organisation_name": "West Suffolk Council",
        "supplier_name": "WFL (UK) Ltd t/a Hall Fuels",
        "year": "2019",
        "month": "4",
        "amount": "14278.22"
      }
    ],
    "pagination": {
      "total_records": "417",
      "current_page": 1,
      "next_page": 2,
      "previous_page": false,
      "records_per_page": "10",
      "total_pages": 42
    },
    "query": {
      "fields": "organisation_name,supplier_name,year,month,amount",
      "filters": [],
      "limit": "10",
      "offset": 0,
      "dataset": "government_purchase_orders",
      "order_by": "id",
      "group_by": "id"
    }
  }
}
Go to top

2.a. Purchase Orders

Purchase orders describe the information about the items and services bought, quantities, suppliers and prices ordered by government organisations.

ENDPOINTS

GET /purchase_orders/id/?token=:token&id=:id
GET /purchase_orders/name/?token=:token&name=:name
GET /purchase_orders/list/?token=:token
GET /purchase_orders/search/?token=:token&query=:query
Go to top

2.b. The Purchase Order Object

Attributes

name string

Unique identifier for the object in string format.

id integer

Unique identifier for the object in numeric format.

organisation_name string

Name of the organisation or local authority

supplier_name string

Name of the supplier or vendor

account_type string

The type of account name

cost_centre string

The cost centre name

description string

Description of goods or services bought

amount float

Total amount spent

year integer

Year of purchase order. For example 2018 or 2023

month integer

Month number of purchase order. For example 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12

source_name string

Name of the source of information

source_url string

URL of the source of information

licence_name string

Name of licence

licence_url string

URL of licence

guid string

Globally Unique Identifier of purchase order object

updated_date datetime

Last date and time of purchase order record was updated

created_date datetime

The date and time the purchase order record was first created

month_name string

Month number of purchase order. For example January, February, March, April, May, June, July, August, September, October, November, December

order_number string

The purchase order number or reference

sovereign_state_name string

Sovereign state name of organisation. For example United Kingdom

country_name string

Country name of organisation. For example England, Scotland

region_name string

Region name of organisation. For example East of England

area_name string

Area name of organisation. For example East Anglia

county_name string

County name of organisation. For example Suffolk

district_name string

District name of organisation. For example West Suffolk District

currency_symbol string

Currency symbol for purchase order. For example £ or € or $

organisation_address_line_1 string

Address line 1 of organisation

organisation_address_line_2 string

Address line 2 of organisation

organisation_town_city_name string

Town or city name of organisation

organisation_county_name string

County name of organisation

organisation_region_name string

Region name of organisation

organisation_postcode string

Postcode of organisation

organisation_country_name string

Country name of organisation

organisation_sovereign_state_name string

Sovereign state name of organisation

organisation_url string

URL of organisation

organisation_procurement_url string

Procurement URL of organisation

organisation_telephone_number string

Telephone number of organisation

organisation_email_address string

Email address of organisation

organisation_facebook_url string

Facebook profile URL of organisation

organisation_youtube_url string

Youtube profile URL of organisation

organisation_instagram_url string

Instagram profile URL of organisation

organisation_x_url string

X profile URL of organisation

organisation_tiktok_url string

TikTok profile URL of organisation

organisation_linkedin_url string

Linkedin profile URL of organisation

organisation_latitude string

Latitude coordinates of organisation address

organisation_longitude string

Longitude coordinates of organisation address

order_date date

Purchase order date. For example 2020-01-12

department_name string

Name of purchase order department

category_name string

Name of purchase order category

section_name string

Name of purchase order section

organisation_id string

Organisation id

supplier_id string

Unique supplier id

the purchase order object

{
      "name": "3e8e97e78239d166191aee72eb49e55f",
      "id": "1",
      "organisation_name": "West Suffolk Council",
      "supplier_name": "RG Carter Southern Ltd",
      "account_type": "Capital Expenditure",
      "cost_centre": "Balance Sheet",
      "description": "Mildenhall Hub - Payment Certificate",
      "amount": "390725",
      "year": "2019",
      "month": "4",
      "source_name": "West Suffolk Council",
      "source_url": "https://www.westsuffolk.gov.uk/",
      "licence_name": "Open Government Licence (OGL)",
      "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
      "guid": "3e8e97e78239d166191aee72eb49e55f",
      "updated_date": "2025-02-03 12:56:59",
      "created_date": "2025-02-03 12:56:59",
      "month_name": "April",
      "order_number": "8050488",
      "sovereign_state_name": "United Kingdom",
      "country_name": "England",
      "region_name": "East of England",
      "area_name": "East Anglia",
      "county_name": "Suffolk",
      "district_name": "West Suffolk District",
      "currency_symbol": "£",
      "organisation_address_line_1": "West Suffolk House",
      "organisation_address_line_2": "Western Way",
      "organisation_town_city_name": "Bury St Edmunds",
      "organisation_county_name": "Suffolk",
      "organisation_region_name": "East of England",
      "organisation_postcode": "IP33 3YU",
      "organisation_country_name": "England",
      "organisation_sovereign_state_name": "United Kingdom",
      "organisation_url": "https://www.westsuffolk.gov.uk",
      "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
      "organisation_telephone_number": "01284 757310",
      "organisation_email_address": "procurement@westsuffolk.gov.uk",
      "organisation_facebook_url": "https://www.facebook.com/WestS",
      "organisation_youtube_url": "",
      "organisation_instagram_url": "https://www.instagram.com/west",
      "organisation_x_url": "https://twitter.com/west_suffo",
      "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
      "organisation_linkedin_url": "",
      "organisation_latitude": "52.251474",
      "organisation_longitude": "0.697005",
      "order_date": "2019-04-01",
      "department_name": "Goods and Services",
      "category_name": "Goods and Services",
      "section_name": "Goods and Services",
      "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
      "supplier_id": "a86a8ea28d493dc9863cdb4dfe2e9918"
    }
Go to top

2.c. Get Purchase Order By Id

Retrieves the purchase order object with the given identifier.

Test Endpoint

Authorisation

Requires Rapidapi Key for api authorisation.

Related guide: Authentication

Parameters

id integer required

Unique identifier for the object in numeric format.

fields string optional (can be left blank)

Only return the Purchase Orders with the list of fields specified. Default is * or all available fields are returned. Can be left blank or not included.

Available fields list

*, id, organisation_name, supplier_name, account_type, cost_centre, description, amount, year, month, source_name, source_url, licence_name, licence_url, guid, updated_date, created_date, month_name, order_number, sovereign_state_name, country_name, region_name, area_name, county_name, district_name, currency_symbol, organisation_address_line_1, organisation_address_line_2, organisation_town_city_name, organisation_county_name, organisation_region_name, organisation_postcode, organisation_country_name, organisation_sovereign_state_name, organisation_url, organisation_procurement_url, organisation_telephone_number, organisation_email_address, organisation_facebook_url, organisation_youtube_url, organisation_instagram_url, organisation_x_url, organisation_tiktok_url, organisation_linkedin_url, organisation_latitude, organisation_longitude, order_date, department_name, category_name, section_name, organisation_id, supplier_id

Related guide: Selecting fields

Returns

Returns a purchase order object if a valid identifier was provided.

ENDPOINTS

GET /purchase_orders/id/?token=:token&id=:id

REQUEST

GET /purchase_orders/id/?token=rapidapi-02928-29292-2991AA02-292&id=1 HTTP/1.1
X-Rapidapi-Key: {RAPIDAPI-KEY}
X-Rapidapi-Host: government-purchase-orders-api.p.rapidapi.com
Host: government-purchase-orders-api.p.rapidapi.com

RESPONSE

{
  "status": "success",
  "code": 200,
  "message": "OK. Everything worked as expected.",
  "result": {
    "object": "purchase_order",
    "data": {
      "name": "3e8e97e78239d166191aee72eb49e55f",
      "id": 1,
      "organisation_name": "West Suffolk Council",
      "supplier_name": "RG Carter Southern Ltd",
      "account_type": "Capital Expenditure",
      "cost_centre": "Balance Sheet",
      "description": "Mildenhall Hub - Payment Certificate",
      "amount": 390725,
      "year": 2019,
      "month": 4,
      "source_name": "West Suffolk Council",
      "source_url": "https://www.westsuffolk.gov.uk/",
      "licence_name": "Open Government Licence OGL",
      "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
      "guid": "3e8e97e78239d166191aee72eb49e55f",
      "updated_date": "2025-02-14 13:23:50",
      "created_date": "2025-02-14 13:23:50",
      "month_name": "April",
      "order_number": "8050488",
      "sovereign_state_name": "United Kingdom",
      "country_name": "England",
      "region_name": "East of England",
      "area_name": "East Anglia",
      "county_name": "Suffolk",
      "district_name": "West Suffolk District",
      "currency_symbol": "£",
      "organisation_address_line_1": "West Suffolk House",
      "organisation_address_line_2": "Western Way",
      "organisation_town_city_name": "Bury St Edmunds",
      "organisation_county_name": "Suffolk",
      "organisation_region_name": "East of England",
      "organisation_postcode": "IP33 3YU",
      "organisation_country_name": "England",
      "organisation_sovereign_state_name": "United Kingdom",
      "organisation_url": "https://www.westsuffolk.gov.uk",
      "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
      "organisation_telephone_number": "01284 757310",
      "organisation_email_address": "procurement@westsuffolk.gov.uk",
      "organisation_facebook_url": "https://www.facebook.com/WestSuffolkCouncil/",
      "organisation_youtube_url": "",
      "organisation_instagram_url": "https://www.instagram.com/westsuffolkcouncil/",
      "organisation_x_url": "https://twitter.com/west_suffolk",
      "organisation_tiktok_url": "https://www.tiktok.com/@westsuffolkcouncil",
      "organisation_linkedin_url": "",
      "organisation_latitude": "52.251474",
      "organisation_longitude": "0.697005",
      "order_date": "2019-04-01",
      "department_name": "Goods and Services",
      "category_name": "Goods and Services",
      "section_name": "Goods and Services",
      "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
      "supplier_id": "a86a8ea28d493dc9863cdb4dfe2e9918"
    },
    "query": {
      "fields": "*",
      "filters": {
        "id": "1"
      },
      "limit": 1,
      "offset": 1,
      "dataset": "government_purchase_orders",
      "order_by": "id",
      "group_by": "id"
    }
  }
}
Go to top

2.d. Get Purchase Order By Name

Retrieves the purchase order object with the given name.

Test Endpoint

Authorisation

Requires Rapidapi Key for api authorisation.

Related guide: Authentication

Parameters

name string required

Unique name for the object in string format.

fields string optional (can be left blank)

Only return the Purchase Orders with the list of fields specified. Default is * or all available fields are returned. Can be left blank or not included.

Available fields list

*, id, organisation_name, supplier_name, account_type, cost_centre, description, amount, year, month, source_name, source_url, licence_name, licence_url, guid, updated_date, created_date, month_name, order_number, sovereign_state_name, country_name, region_name, area_name, county_name, district_name, currency_symbol, organisation_address_line_1, organisation_address_line_2, organisation_town_city_name, organisation_county_name, organisation_region_name, organisation_postcode, organisation_country_name, organisation_sovereign_state_name, organisation_url, organisation_procurement_url, organisation_telephone_number, organisation_email_address, organisation_facebook_url, organisation_youtube_url, organisation_instagram_url, organisation_x_url, organisation_tiktok_url, organisation_linkedin_url, organisation_latitude, organisation_longitude, order_date, department_name, category_name, section_name, organisation_id, supplier_id

Related guide: Selecting fields

Returns

Returns a purchase order object if a valid name was provided.

ENDPOINTS

GET /purchase_orders/name/?token=:token&name=:name

REQUEST

GET /purchase_orders/name/?token=rapidapi-02928-29292-2991AA02-292&name=3e8e97e78239d166191aee72eb49e55f HTTP/1.1
X-Rapidapi-Key: {RAPIDAPI-KEY}
X-Rapidapi-Host: government-purchase-orders-api.p.rapidapi.com
Host: government-purchase-orders-api.p.rapidapi.com

RESPONSE

{
  "status": "success",
  "code": 200,
  "message": "OK. Everything worked as expected.",
  "result": {
    "object": "purchase_order",
    "data": {
      "name": "3e8e97e78239d166191aee72eb49e55f",
      "id": "1",
      "organisation_name": "West Suffolk Council",
      "supplier_name": "RG Carter Southern Ltd",
      "account_type": "Capital Expenditure",
      "cost_centre": "Balance Sheet",
      "description": "Mildenhall Hub - Payment Certificate",
      "amount": "390725",
      "year": "2019",
      "month": "4",
      "source_name": "West Suffolk Council",
      "source_url": "https://www.westsuffolk.gov.uk/",
      "licence_name": "Open Government Licence (OGL)",
      "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
      "guid": "3e8e97e78239d166191aee72eb49e55f",
      "updated_date": "2025-02-03 12:56:59",
      "created_date": "2025-02-03 12:56:59",
      "month_name": "April",
      "order_number": "8050488",
      "sovereign_state_name": "United Kingdom",
      "country_name": "England",
      "region_name": "East of England",
      "area_name": "East Anglia",
      "county_name": "Suffolk",
      "district_name": "West Suffolk District",
      "currency_symbol": "£",
      "organisation_address_line_1": "West Suffolk House",
      "organisation_address_line_2": "Western Way",
      "organisation_town_city_name": "Bury St Edmunds",
      "organisation_county_name": "Suffolk",
      "organisation_region_name": "East of England",
      "organisation_postcode": "IP33 3YU",
      "organisation_country_name": "England",
      "organisation_sovereign_state_name": "United Kingdom",
      "organisation_url": "https://www.westsuffolk.gov.uk",
      "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
      "organisation_telephone_number": "01284 757310",
      "organisation_email_address": "procurement@westsuffolk.gov.uk",
      "organisation_facebook_url": "https://www.facebook.com/WestS",
      "organisation_youtube_url": "",
      "organisation_instagram_url": "https://www.instagram.com/west",
      "organisation_x_url": "https://twitter.com/west_suffo",
      "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
      "organisation_linkedin_url": "",
      "organisation_latitude": "52.251474",
      "organisation_longitude": "0.697005",
      "order_date": "2019-04-01",
      "department_name": "Goods and Services",
      "category_name": "Goods and Services",
      "section_name": "Goods and Services",
      "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
      "supplier_id": "a86a8ea28d493dc9863cdb4dfe2e9918"
    }
  }
}
Go to top

2.e. List Purchase Orders

Returns a list of purchase orders.

Test Endpoint

Authorisation

Requires Rapidapi Key for api authorisation.

Related guide: Authentication

Parameters

fields string optional (can be left blank)

Only return the Purchase Orders with the list of fields specified. Default is * or all available fields are returned. Can be left blank or not included.

Related guide: Selecting fields

Available fields list

*, id, organisation_name, supplier_name, account_type, cost_centre, description, amount, year, month, source_name, source_url, licence_name, licence_url, guid, updated_date, created_date, month_name, order_number, sovereign_state_name, country_name, region_name, area_name, county_name, district_name, currency_symbol, organisation_address_line_1, organisation_address_line_2, organisation_town_city_name, organisation_county_name, organisation_region_name, organisation_postcode, organisation_country_name, organisation_sovereign_state_name, organisation_url, organisation_procurement_url, organisation_telephone_number, organisation_email_address, organisation_facebook_url, organisation_youtube_url, organisation_instagram_url, organisation_x_url, organisation_tiktok_url, organisation_linkedin_url, organisation_latitude, organisation_longitude, order_date, department_name, category_name, section_name, organisation_id, supplier_id

order_by string optional (can be left blank)

Return the Purchase Orders with the ordering specified. Can be left blank or not included.

Related guide: Ordering rows

Available fields list

id, id asc, id desc, organisation_name, organisation_name asc, organisation_name desc, supplier_name, supplier_name asc, supplier_name desc, amount, amount asc, amount desc, account_type, account_type asc, account_type desc, cost_centre, cost_centre asc, cost_centre desc, year, year asc, year desc, month, month asc, month desc, order_date, order_date asc, order_date desc, order_number, order_number asc, order_number desc, sovereign_state_name, sovereign_state_name asc, sovereign_state_name desc, country_name, country_name asc, country_name desc, region_name, region_name asc, region_name desc, area_name, area_name asc, area_name desc, county_name, county_name asc, county_name desc, district_name, district_name asc, district_name desc

group_by string optional (can be left blank)

Groups the Purchase Orders with the grouping specified. Can be left blank or not included.

Related guide: Grouping rows

Available fields list

id, name, organisation_name, supplier_name, account_type, cost_centre, amount, year, month, guid, month_name, order_number, sovereign_state_name, country_name, county_name, region_name, area_name, district_name, order_date, department_name, category_name, section_name, organisation_id, supplier_id

id integer filter optional (can be left blank)

Only return the Purchase Order for the identifier specified. Can be left blank or not included.

name string filter optional (can be left blank)

Only return the Purchase Order for the name specified. Can be left blank or not included.

organisation_name string filter optional (can be left blank)

Only return the Purchase Orders for the organisation name specified. Can be left blank or not included.

supplier_name string filter optional (can be left blank)

Only return the Purchase Orders for the supplier name specified. Can be left blank or not included.

account_type string filter optional (can be left blank)

Only return the Purchase Orders for the account type specified. Can be left blank or not included.

cost_centre string filter optional (can be left blank)

Only return the Purchase Orders for the cost centre specified. Can be left blank or not included.

amount float filter optional (can be left blank)

Only return the Purchase Orders for the amount specified. Can be left blank or not included.

year integer filter optional (can be left blank)

Only return the Purchase Orders for the year specified. Can be left blank or not included.

month integer filter optional (can be left blank)

Only return the Purchase Orders for the month specified. Can be left blank or not included.

guid string filter optional (can be left blank)

Only return the Purchase Orders for the Globally Unique Identifier specified. Can be left blank or not included.

month_name string filter optional (can be left blank)

Only return the Purchase Orders for the month name specified. Can be left blank or not included.

order_number string filter optional (can be left blank)

Only return the Purchase Orders for the order number specified. Can be left blank or not included.

sovereign_state_name string filter optional (can be left blank)

Only return the Purchase Orders for the sovereign state name specified. Can be left blank or not included.

country_name string filter optional (can be left blank)

Only return the Purchase Orders for the country name specified. Can be left blank or not included.

county_name string filter optional (can be left blank)

Only return the Purchase Orders for the county name specified. Can be left blank or not included.

region_name string filter optional (can be left blank)

Only return the Purchase Orders for the region name specified. Can be left blank or not included.

area_name string filter optional (can be left blank)

Only return the Purchase Orders for the area name specified. Can be left blank or not included.

district_name string filter optional (can be left blank)

Only return the Purchase Orders for the district name specified. Can be left blank or not included.

order_date string filter optional (can be left blank)

Only return the Purchase Orders for the order date specified. Can be left blank or not included.

department_name string filter optional (can be left blank)

Only return the Purchase Orders for the department name specified. Can be left blank or not included.

category_name string filter optional (can be left blank)

Only return the Purchase Orders for the category name specified. Can be left blank or not included.

section_name string filter optional (can be left blank)

Only return the Purchase Orders for the section name specified. Can be left blank or not included.

organisation_id string filter optional (can be left blank)

Only return the Purchase Orders for the organisation id specified. Can be left blank or not included.

supplier_id string filter optional (can be left blank)

Only return the Purchase Orders for the supplier id specified. Can be left blank or not included.

Returns

A dictionary with a data property that contains an array of up to limit purchase orders, starting after page. Each entry in the data array is a separate purchase order object. If no more purchase orders are available, the resulting array will be empty.

ENDPOINTS

GET /purchase_orders/list/?token=:token

REQUEST

GET /purchase_orders/list/?token=rapidapi-02928-29292-2991AA02-292 HTTP/1.1
X-Rapidapi-Key: {RAPIDAPI-KEY}
X-Rapidapi-Host: government-purchase-orders-api.p.rapidapi.com
Host: government-purchase-orders-api.p.rapidapi.com

RESPONSE

{
  "status": "success",
  "code": 200,
  "message": "OK. Everything worked as expected.",
  "result": {
    "object": "list",
    "data": [
      {
        "name": "3e8e97e78239d166191aee72eb49e55f",
        "id": "1",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "RG Carter Southern Ltd",
        "account_type": "Capital Expenditure",
        "cost_centre": "Balance Sheet",
        "description": "Mildenhall Hub - Payment Certificate",
        "amount": "390725",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "3e8e97e78239d166191aee72eb49e55f",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050488",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "a86a8ea28d493dc9863cdb4dfe2e9918"
      },
      {
        "name": "407dbc3a2fdb7f69e94736378f2416f5",
        "id": "2",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Local Government Association",
        "account_type": "Subscriptions",
        "cost_centre": "Corporate Expenditure",
        "description": "LGA Membership Subscription",
        "amount": "10450",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "407dbc3a2fdb7f69e94736378f2416f5",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8051073",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "cf8159e706828b60449192be2c998b1e"
      },
      {
        "name": "3d304776301b1bf7c5863fd5b6714d75",
        "id": "3",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Cale Access UK Ltd",
        "account_type": "TPP - Other",
        "cost_centre": "Off Street Car Parks",
        "description": "MP104 to CWT-C Upgrade",
        "amount": "9032",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "3d304776301b1bf7c5863fd5b6714d75",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050360",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "8ae1369f29aea431ad5eb0277991bb7c"
      },
      {
        "name": "31c2ee04b5cc16d3e8408eeebd4f8627",
        "id": "4",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Cobalt Telephone Technologies Ltd",
        "account_type": "Services - Fees and Charges",
        "cost_centre": "Off Street Car Parks",
        "description": "SEBC RingGo Fee",
        "amount": "7132.98",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "31c2ee04b5cc16d3e8408eeebd4f8627",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050797",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "df415080e831ac7f9138fbb1edc46393"
      },
      {
        "name": "5210274d952c1be5f6b7cf152a08b2d4",
        "id": "5",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Truetech Integrated Ltd",
        "account_type": "TPP - Other",
        "cost_centre": "Off Street Car Parks",
        "description": "Body Cameras",
        "amount": "7432.8",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "5210274d952c1be5f6b7cf152a08b2d4",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050963",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "de8fdd823ae9f427a1ece1c63ee18c37"
      },
      {
        "name": "c42b9cc8d1bf66b04c40d00724f3f2d6",
        "id": "6",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Modern Mindset Ltd",
        "account_type": "Computing - Purchase of Hardware",
        "cost_centre": "Democratic Services",
        "description": "modern.gov",
        "amount": "10250",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "c42b9cc8d1bf66b04c40d00724f3f2d6",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050436",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "1ee2fdd8b560bbcfa7927d30d52587f5"
      },
      {
        "name": "4495daae0c1033ae1658447b05ebd420",
        "id": "7",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Greencells GmbH",
        "account_type": "R & M of Plant & Equipment",
        "cost_centre": "Solar Farm",
        "description": "R & M of Plant & Equipment",
        "amount": "5290",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "4495daae0c1033ae1658447b05ebd420",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050649",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "ba6f1610d572201a8c0d3520b0c591ec"
      },
      {
        "name": "5e47087640d45414a3148016e5d37143",
        "id": "8",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "United Stage International Limited",
        "account_type": "Artistes/Performers Fees",
        "cost_centre": "Bury Festival",
        "description": "Artiste Fees",
        "amount": "8000",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "5e47087640d45414a3148016e5d37143",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050952",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "0b6efc158a700a107b01ca2ed68121d0"
      },
      {
        "name": "4ccd8c159cec5cc848b32795b97b1a73",
        "id": "9",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Hazard Chase Limited",
        "account_type": "Artistes/Performers Fees",
        "cost_centre": "Bury Festival",
        "description": "Artiste Fees",
        "amount": "7850",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "4ccd8c159cec5cc848b32795b97b1a73",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050955",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "a70a522bdc27065bfa4aceaa73cdaa6f"
      },
      {
        "name": "02c38584d5312d2deaf4bb95ae68a86a",
        "id": "10",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "WFL (UK) Ltd t/a Hall Fuels",
        "account_type": "Stock - For Internal Use",
        "cost_centre": "Balance Sheet",
        "description": "Fuel for BSE",
        "amount": "14278.22",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "02c38584d5312d2deaf4bb95ae68a86a",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050633",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "1693e2b09d4ceddd19873d51930bc684"
      }
    ],
    "pagination": {
      "total_records": "417",
      "current_page": 1,
      "next_page": 2,
      "previous_page": false,
      "records_per_page": "10",
      "total_pages": 42
    },
    "query": {
      "fields": "*",
      "filters": [],
      "limit": "10",
      "offset": 0,
      "dataset": "government_purchase_orders",
      "order_by": "id",
      "group_by": "id"
    }
  }
}
Go to top

2.f. Search Purchase Orders

Returns a list of purchase orders given a search query string.

Test Endpoint

Authorisation

Requires Rapidapi Key for api authorisation.

Related guide: Authentication

Parameters

query string required

The search query string.

fields string optional (can be left blank)

Only return the Purchase Orders with the list of fields specified. Default is * or all available fields are returned. Can be left blank or not included.

Related guide: Selecting fields

Available fields list

*, id, organisation_name, supplier_name, account_type, cost_centre, description, amount, year, month, source_name, source_url, licence_name, licence_url, guid, updated_date, created_date, month_name, order_number, sovereign_state_name, country_name, region_name, area_name, county_name, district_name, currency_symbol, organisation_address_line_1, organisation_address_line_2, organisation_town_city_name, organisation_county_name, organisation_region_name, organisation_postcode, organisation_country_name, organisation_sovereign_state_name, organisation_url, organisation_procurement_url, organisation_telephone_number, organisation_email_address, organisation_facebook_url, organisation_youtube_url, organisation_instagram_url, organisation_x_url, organisation_tiktok_url, organisation_linkedin_url, organisation_latitude, organisation_longitude, order_date, department_name, category_name, section_name, organisation_id, supplier_id

order_by string optional (can be left blank)

Return the Purchase Orders with the ordering specified. Can be left blank or not included.

Related guide: Ordering rows

Available fields list

id, id asc, id desc, organisation_name, organisation_name asc, organisation_name desc, supplier_name, supplier_name asc, supplier_name desc, amount, amount asc, amount desc, account_type, account_type asc, account_type desc, cost_centre, cost_centre asc, cost_centre desc, year, year asc, year desc, month, month asc, month desc, order_date, order_date asc, order_date desc, order_number, order_number asc, order_number desc, sovereign_state_name, sovereign_state_name asc, sovereign_state_name desc, country_name, country_name asc, country_name desc, region_name, region_name asc, region_name desc, area_name, area_name asc, area_name desc, county_name, county_name asc, county_name desc, district_name, district_name asc, district_name desc

group_by string optional (can be left blank)

Groups the Purchase Orders with the grouping specified. Can be left blank or not included.

Related guide: Grouping rows

Available fields list

id, name, organisation_name, supplier_name, account_type, cost_centre, amount, year, month, guid, month_name, order_number, sovereign_state_name, country_name, county_name, region_name, area_name, district_name, order_date, department_name, category_name, section_name, organisation_id, supplier_id

id integer filter optional (can be left blank)

Only return the Purchase Order for the identifier specified. Can be left blank or not included.

name string filter optional (can be left blank)

Only return the Purchase Order for the name specified. Can be left blank or not included.

organisation_name string filter optional (can be left blank)

Only return the Purchase Orders for the organisation name specified. Can be left blank or not included.

supplier_name string filter optional (can be left blank)

Only return the Purchase Orders for the supplier name specified. Can be left blank or not included.

account_type string filter optional (can be left blank)

Only return the Purchase Orders for the account type specified. Can be left blank or not included.

cost_centre string filter optional (can be left blank)

Only return the Purchase Orders for the cost centre specified. Can be left blank or not included.

amount float filter optional (can be left blank)

Only return the Purchase Orders for the amount specified. Can be left blank or not included.

year integer filter optional (can be left blank)

Only return the Purchase Orders for the year specified. Can be left blank or not included.

month integer filter optional (can be left blank)

Only return the Purchase Orders for the month specified. Can be left blank or not included.

guid string filter optional (can be left blank)

Only return the Purchase Orders for the Globally Unique Identifier specified. Can be left blank or not included.

month_name string filter optional (can be left blank)

Only return the Purchase Orders for the month name specified. Can be left blank or not included.

order_number string filter optional (can be left blank)

Only return the Purchase Orders for the order number specified. Can be left blank or not included.

sovereign_state_name string filter optional (can be left blank)

Only return the Purchase Orders for the sovereign state name specified. Can be left blank or not included.

country_name string filter optional (can be left blank)

Only return the Purchase Orders for the country name specified. Can be left blank or not included.

county_name string filter optional (can be left blank)

Only return the Purchase Orders for the county name specified. Can be left blank or not included.

region_name string filter optional (can be left blank)

Only return the Purchase Orders for the region name specified. Can be left blank or not included.

area_name string filter optional (can be left blank)

Only return the Purchase Orders for the area name specified. Can be left blank or not included.

district_name string filter optional (can be left blank)

Only return the Purchase Orders for the district name specified. Can be left blank or not included.

order_date string filter optional (can be left blank)

Only return the Purchase Orders for the order date specified. Can be left blank or not included.

department_name string filter optional (can be left blank)

Only return the Purchase Orders for the department name specified. Can be left blank or not included.

category_name string filter optional (can be left blank)

Only return the Purchase Orders for the category name specified. Can be left blank or not included.

section_name string filter optional (can be left blank)

Only return the Purchase Orders for the section name specified. Can be left blank or not included.

organisation_id string filter optional (can be left blank)

Only return the Purchase Orders for the organisation id specified. Can be left blank or not included.

supplier_id string filter optional (can be left blank)

Only return the Purchase Orders for the supplier id specified. Can be left blank or not included.

Returns

A dictionary with a data property that contains an array of up to limit purchase orders, starting after page. Each entry in the data array is a separate purchase order object. If no more purchase orders are available, the resulting array will be empty.

ENDPOINTS

GET /purchase_orders/search/?token=:token&query=:query

REQUEST

GET /purchase_orders/search/?token=rapidapi-02928-29292-2991AA02-292&query=west%20suffolk%20council HTTP/1.1
X-Rapidapi-Key: {RAPIDAPI-KEY}
X-Rapidapi-Host: government-purchase-orders-api.p.rapidapi.com
Host: government-purchase-orders-api.p.rapidapi.com

RESPONSE

{
  "status": "success",
  "code": 200,
  "message": "OK. Everything worked as expected.",
  "result": {
    "object": "search_result",
    "data": [
      {
        "name": "3e8e97e78239d166191aee72eb49e55f",
        "id": "1",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "RG Carter Southern Ltd",
        "account_type": "Capital Expenditure",
        "cost_centre": "Balance Sheet",
        "description": "Mildenhall Hub - Payment Certificate",
        "amount": "390725",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "3e8e97e78239d166191aee72eb49e55f",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050488",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "a86a8ea28d493dc9863cdb4dfe2e9918"
      },
      {
        "name": "407dbc3a2fdb7f69e94736378f2416f5",
        "id": "2",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Local Government Association",
        "account_type": "Subscriptions",
        "cost_centre": "Corporate Expenditure",
        "description": "LGA Membership Subscription",
        "amount": "10450",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "407dbc3a2fdb7f69e94736378f2416f5",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8051073",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "cf8159e706828b60449192be2c998b1e"
      },
      {
        "name": "3d304776301b1bf7c5863fd5b6714d75",
        "id": "3",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Cale Access UK Ltd",
        "account_type": "TPP - Other",
        "cost_centre": "Off Street Car Parks",
        "description": "MP104 to CWT-C Upgrade",
        "amount": "9032",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "3d304776301b1bf7c5863fd5b6714d75",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050360",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "8ae1369f29aea431ad5eb0277991bb7c"
      },
      {
        "name": "31c2ee04b5cc16d3e8408eeebd4f8627",
        "id": "4",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Cobalt Telephone Technologies Ltd",
        "account_type": "Services - Fees and Charges",
        "cost_centre": "Off Street Car Parks",
        "description": "SEBC RingGo Fee",
        "amount": "7132.98",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "31c2ee04b5cc16d3e8408eeebd4f8627",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050797",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "df415080e831ac7f9138fbb1edc46393"
      },
      {
        "name": "5210274d952c1be5f6b7cf152a08b2d4",
        "id": "5",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Truetech Integrated Ltd",
        "account_type": "TPP - Other",
        "cost_centre": "Off Street Car Parks",
        "description": "Body Cameras",
        "amount": "7432.8",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "5210274d952c1be5f6b7cf152a08b2d4",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050963",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "de8fdd823ae9f427a1ece1c63ee18c37"
      },
      {
        "name": "c42b9cc8d1bf66b04c40d00724f3f2d6",
        "id": "6",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Modern Mindset Ltd",
        "account_type": "Computing - Purchase of Hardware",
        "cost_centre": "Democratic Services",
        "description": "modern.gov",
        "amount": "10250",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "c42b9cc8d1bf66b04c40d00724f3f2d6",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050436",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "1ee2fdd8b560bbcfa7927d30d52587f5"
      },
      {
        "name": "4495daae0c1033ae1658447b05ebd420",
        "id": "7",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Greencells GmbH",
        "account_type": "R & M of Plant & Equipment",
        "cost_centre": "Solar Farm",
        "description": "R & M of Plant & Equipment",
        "amount": "5290",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "4495daae0c1033ae1658447b05ebd420",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050649",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "ba6f1610d572201a8c0d3520b0c591ec"
      },
      {
        "name": "5e47087640d45414a3148016e5d37143",
        "id": "8",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "United Stage International Limited",
        "account_type": "Artistes/Performers Fees",
        "cost_centre": "Bury Festival",
        "description": "Artiste Fees",
        "amount": "8000",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "5e47087640d45414a3148016e5d37143",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050952",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "0b6efc158a700a107b01ca2ed68121d0"
      },
      {
        "name": "4ccd8c159cec5cc848b32795b97b1a73",
        "id": "9",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Hazard Chase Limited",
        "account_type": "Artistes/Performers Fees",
        "cost_centre": "Bury Festival",
        "description": "Artiste Fees",
        "amount": "7850",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "4ccd8c159cec5cc848b32795b97b1a73",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050955",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "a70a522bdc27065bfa4aceaa73cdaa6f"
      },
      {
        "name": "02c38584d5312d2deaf4bb95ae68a86a",
        "id": "10",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "WFL (UK) Ltd t/a Hall Fuels",
        "account_type": "Stock - For Internal Use",
        "cost_centre": "Balance Sheet",
        "description": "Fuel for BSE",
        "amount": "14278.22",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "02c38584d5312d2deaf4bb95ae68a86a",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050633",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "1693e2b09d4ceddd19873d51930bc684"
      }
    ],
    "pagination": {
      "total_records": "61",
      "current_page": 1,
      "next_page": 2,
      "previous_page": false,
      "records_per_page": "10",
      "total_pages": 6
    },
    "query": {
      "fields": "*",
      "query": "Suffolk",
      "filters": {
        "month_name": "April"
      },
      "limit": "10",
      "offset": 0,
      "dataset": "government_purchase_orders",
      "order_by": "id",
      "group_by": "id"
    }
  }
}
Go to top

2.g. List Count Purchase Orders

Returns a list of number of purchase orders.

Test Endpoint

Authorisation

Requires Rapidapi Key for api authorisation.

Related guide: Authentication

Parameters

 

order_by string optional (can be left blank)

Return the Purchase Orders with the ordering specified. Can be left blank or not included.

Related guide: Ordering rows

Available fields list

total, total asc, total desc,id, id asc, id desc, organisation_name, organisation_name asc, organisation_name desc, supplier_name, supplier_name asc, supplier_name desc, amount, amount asc, amount desc, account_type, account_type asc, account_type desc, cost_centre, cost_centre asc, cost_centre desc, year, year asc, year desc, month, month asc, month desc, order_date, order_date asc, order_date desc, order_number, order_number asc, order_number desc, sovereign_state_name, sovereign_state_name asc, sovereign_state_name desc, country_name, country_name asc, country_name desc, region_name, region_name asc, region_name desc, area_name, area_name asc, area_name desc, county_name, county_name asc, county_name desc, district_name, district_name asc, district_name desc

group_by string optional (can be left blank)

Groups the Purchase Orders with the grouping specified. Can be left blank or not included.

Related guide: Grouping rows

Available fields list

id, name, organisation_name, supplier_name, account_type, cost_centre, amount, year, month, guid, month_name, order_number, sovereign_state_name, country_name, county_name, region_name, area_name, district_name, order_date, department_name, category_name, section_name, organisation_id, supplier_id

id integer filter optional (can be left blank)

Only return the Purchase Order for the identifier specified. Can be left blank or not included.

name string filter optional (can be left blank)

Only return the Purchase Order for the name specified. Can be left blank or not included.

organisation_name string filter optional (can be left blank)

Only return the Purchase Orders for the organisation name specified. Can be left blank or not included.

supplier_name string filter optional (can be left blank)

Only return the Purchase Orders for the supplier name specified. Can be left blank or not included.

account_type string filter optional (can be left blank)

Only return the Purchase Orders for the account type specified. Can be left blank or not included.

cost_centre string filter optional (can be left blank)

Only return the Purchase Orders for the cost centre specified. Can be left blank or not included.

amount float filter optional (can be left blank)

Only return the Purchase Orders for the amount specified. Can be left blank or not included.

year integer filter optional (can be left blank)

Only return the Purchase Orders for the year specified. Can be left blank or not included.

month integer filter optional (can be left blank)

Only return the Purchase Orders for the month specified. Can be left blank or not included.

guid string filter optional (can be left blank)

Only return the Purchase Orders for the Globally Unique Identifier specified. Can be left blank or not included.

month_name string filter optional (can be left blank)

Only return the Purchase Orders for the month name specified. Can be left blank or not included.

order_number string filter optional (can be left blank)

Only return the Purchase Orders for the order number specified. Can be left blank or not included.

sovereign_state_name string filter optional (can be left blank)

Only return the Purchase Orders for the sovereign state name specified. Can be left blank or not included.

country_name string filter optional (can be left blank)

Only return the Purchase Orders for the country name specified. Can be left blank or not included.

county_name string filter optional (can be left blank)

Only return the Purchase Orders for the county name specified. Can be left blank or not included.

region_name string filter optional (can be left blank)

Only return the Purchase Orders for the region name specified. Can be left blank or not included.

area_name string filter optional (can be left blank)

Only return the Purchase Orders for the area name specified. Can be left blank or not included.

district_name string filter optional (can be left blank)

Only return the Purchase Orders for the district name specified. Can be left blank or not included.

order_date string filter optional (can be left blank)

Only return the Purchase Orders for the order date specified. Can be left blank or not included.

department_name string filter optional (can be left blank)

Only return the Purchase Orders for the department name specified. Can be left blank or not included.

category_name string filter optional (can be left blank)

Only return the Purchase Orders for the category name specified. Can be left blank or not included.

section_name string filter optional (can be left blank)

Only return the Purchase Orders for the section name specified. Can be left blank or not included.

organisation_id string filter optional (can be left blank)

Only return the Purchase Orders for the organisation id specified. Can be left blank or not included.

supplier_id string filter optional (can be left blank)

Only return the Purchase Orders for the supplier id specified. Can be left blank or not included.

Returns

A dictionary with a data property that contains an array of up to limit number of purchase orders, starting after page. Each entry in the data array is a separate number of purchase order object. If no more purchase orders are available, the resulting array will be empty.

ENDPOINTS

GET /purchase_orders/list_count/?token=:token

REQUEST

GET /purchase_orders/list_count/?token=rapidapi-02928-29292-2991AA02-292 HTTP/1.1
X-Rapidapi-Key: {RAPIDAPI-KEY}
X-Rapidapi-Host: government-purchase-orders-api.p.rapidapi.com
Host: government-purchase-orders-api.p.rapidapi.com

RESPONSE

{
  "status": "success",
  "code": 200,
  "message": "OK. Everything worked as expected.",
  "result": {
    "object": "list",
    "data": [
      {
        "name": "3e8e97e78239d166191aee72eb49e55f",
        "id": "1",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "RG Carter Southern Ltd",
        "account_type": "Capital Expenditure",
        "cost_centre": "Balance Sheet",
        "description": "Mildenhall Hub - Payment Certificate",
        "amount": "390725",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "3e8e97e78239d166191aee72eb49e55f",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050488",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "a86a8ea28d493dc9863cdb4dfe2e9918"
      },
      {
        "name": "407dbc3a2fdb7f69e94736378f2416f5",
        "id": "2",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Local Government Association",
        "account_type": "Subscriptions",
        "cost_centre": "Corporate Expenditure",
        "description": "LGA Membership Subscription",
        "amount": "10450",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "407dbc3a2fdb7f69e94736378f2416f5",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8051073",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "cf8159e706828b60449192be2c998b1e"
      },
      {
        "name": "3d304776301b1bf7c5863fd5b6714d75",
        "id": "3",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Cale Access UK Ltd",
        "account_type": "TPP - Other",
        "cost_centre": "Off Street Car Parks",
        "description": "MP104 to CWT-C Upgrade",
        "amount": "9032",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "3d304776301b1bf7c5863fd5b6714d75",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050360",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "8ae1369f29aea431ad5eb0277991bb7c"
      },
      {
        "name": "31c2ee04b5cc16d3e8408eeebd4f8627",
        "id": "4",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Cobalt Telephone Technologies Ltd",
        "account_type": "Services - Fees and Charges",
        "cost_centre": "Off Street Car Parks",
        "description": "SEBC RingGo Fee",
        "amount": "7132.98",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "31c2ee04b5cc16d3e8408eeebd4f8627",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050797",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "df415080e831ac7f9138fbb1edc46393"
      },
      {
        "name": "5210274d952c1be5f6b7cf152a08b2d4",
        "id": "5",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Truetech Integrated Ltd",
        "account_type": "TPP - Other",
        "cost_centre": "Off Street Car Parks",
        "description": "Body Cameras",
        "amount": "7432.8",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "5210274d952c1be5f6b7cf152a08b2d4",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050963",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "de8fdd823ae9f427a1ece1c63ee18c37"
      },
      {
        "name": "c42b9cc8d1bf66b04c40d00724f3f2d6",
        "id": "6",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Modern Mindset Ltd",
        "account_type": "Computing - Purchase of Hardware",
        "cost_centre": "Democratic Services",
        "description": "modern.gov",
        "amount": "10250",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "c42b9cc8d1bf66b04c40d00724f3f2d6",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050436",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "1ee2fdd8b560bbcfa7927d30d52587f5"
      },
      {
        "name": "4495daae0c1033ae1658447b05ebd420",
        "id": "7",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Greencells GmbH",
        "account_type": "R & M of Plant & Equipment",
        "cost_centre": "Solar Farm",
        "description": "R & M of Plant & Equipment",
        "amount": "5290",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "4495daae0c1033ae1658447b05ebd420",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050649",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "ba6f1610d572201a8c0d3520b0c591ec"
      },
      {
        "name": "5e47087640d45414a3148016e5d37143",
        "id": "8",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "United Stage International Limited",
        "account_type": "Artistes/Performers Fees",
        "cost_centre": "Bury Festival",
        "description": "Artiste Fees",
        "amount": "8000",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "5e47087640d45414a3148016e5d37143",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050952",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "0b6efc158a700a107b01ca2ed68121d0"
      },
      {
        "name": "4ccd8c159cec5cc848b32795b97b1a73",
        "id": "9",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Hazard Chase Limited",
        "account_type": "Artistes/Performers Fees",
        "cost_centre": "Bury Festival",
        "description": "Artiste Fees",
        "amount": "7850",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "4ccd8c159cec5cc848b32795b97b1a73",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050955",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "a70a522bdc27065bfa4aceaa73cdaa6f"
      },
      {
        "name": "02c38584d5312d2deaf4bb95ae68a86a",
        "id": "10",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "WFL (UK) Ltd t/a Hall Fuels",
        "account_type": "Stock - For Internal Use",
        "cost_centre": "Balance Sheet",
        "description": "Fuel for BSE",
        "amount": "14278.22",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "02c38584d5312d2deaf4bb95ae68a86a",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050633",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "1693e2b09d4ceddd19873d51930bc684"
      }
    ],
    "pagination": {
      "total_records": "417",
      "current_page": 1,
      "next_page": 2,
      "previous_page": false,
      "records_per_page": "10",
      "total_pages": 42
    },
    "query": {
      "fields": "*",
      "filters": [],
      "limit": "10",
      "offset": 0,
      "dataset": "government_purchase_orders",
      "order_by": "id",
      "group_by": "id"
    }
  }
}
Go to top

2.h. Search Count Purchase Orders

Returns a list of number of purchase orders given a search query string.

Test Endpoint

Authorisation

Requires Rapidapi Key for api authorisation.

Related guide: Authentication

Parameters

query string required

The search query string.

order_by string optional (can be left blank)

Return the Purchase Orders with the ordering specified. Can be left blank or not included.

Related guide: Ordering rows

Available fields list

total,total asc,total desc,id, id asc, id desc, organisation_name, organisation_name asc, organisation_name desc, supplier_name, supplier_name asc, supplier_name desc, amount, amount asc, amount desc, account_type, account_type asc, account_type desc, cost_centre, cost_centre asc, cost_centre desc, year, year asc, year desc, month, month asc, month desc, order_date, order_date asc, order_date desc, order_number, order_number asc, order_number desc, sovereign_state_name, sovereign_state_name asc, sovereign_state_name desc, country_name, country_name asc, country_name desc, region_name, region_name asc, region_name desc, area_name, area_name asc, area_name desc, county_name, county_name asc, county_name desc, district_name, district_name asc, district_name desc

group_by string optional (can be left blank)

Groups the Purchase Orders with the grouping specified. Can be left blank or not included.

Related guide: Grouping rows

Available fields list

id, name, organisation_name, supplier_name, account_type, cost_centre, amount, year, month, guid, month_name, order_number, sovereign_state_name, country_name, county_name, region_name, area_name, district_name, order_date, department_name, category_name, section_name, organisation_id, supplier_id

id integer filter optional (can be left blank)

Only return the Purchase Order for the identifier specified. Can be left blank or not included.

name string filter optional (can be left blank)

Only return the Purchase Order for the name specified. Can be left blank or not included.

organisation_name string filter optional (can be left blank)

Only return the Purchase Orders for the organisation name specified. Can be left blank or not included.

supplier_name string filter optional (can be left blank)

Only return the Purchase Orders for the supplier name specified. Can be left blank or not included.

account_type string filter optional (can be left blank)

Only return the Purchase Orders for the account type specified. Can be left blank or not included.

cost_centre string filter optional (can be left blank)

Only return the Purchase Orders for the cost centre specified. Can be left blank or not included.

amount float filter optional (can be left blank)

Only return the Purchase Orders for the amount specified. Can be left blank or not included.

year integer filter optional (can be left blank)

Only return the Purchase Orders for the year specified. Can be left blank or not included.

month integer filter optional (can be left blank)

Only return the Purchase Orders for the month specified. Can be left blank or not included.

guid string filter optional (can be left blank)

Only return the Purchase Orders for the Globally Unique Identifier specified. Can be left blank or not included.

month_name string filter optional (can be left blank)

Only return the Purchase Orders for the month name specified. Can be left blank or not included.

order_number string filter optional (can be left blank)

Only return the Purchase Orders for the order number specified. Can be left blank or not included.

sovereign_state_name string filter optional (can be left blank)

Only return the Purchase Orders for the sovereign state name specified. Can be left blank or not included.

country_name string filter optional (can be left blank)

Only return the Purchase Orders for the country name specified. Can be left blank or not included.

county_name string filter optional (can be left blank)

Only return the Purchase Orders for the county name specified. Can be left blank or not included.

region_name string filter optional (can be left blank)

Only return the Purchase Orders for the region name specified. Can be left blank or not included.

area_name string filter optional (can be left blank)

Only return the Purchase Orders for the area name specified. Can be left blank or not included.

district_name string filter optional (can be left blank)

Only return the Purchase Orders for the district name specified. Can be left blank or not included.

order_date string filter optional (can be left blank)

Only return the Purchase Orders for the order date specified. Can be left blank or not included.

department_name string filter optional (can be left blank)

Only return the Purchase Orders for the department name specified. Can be left blank or not included.

category_name string filter optional (can be left blank)

Only return the Purchase Orders for the category name specified. Can be left blank or not included.

section_name string filter optional (can be left blank)

Only return the Purchase Orders for the section name specified. Can be left blank or not included.

organisation_id string filter optional (can be left blank)

Only return the Purchase Orders for the organisation id specified. Can be left blank or not included.

supplier_id string filter optional (can be left blank)

Only return the Purchase Orders for the supplier id specified. Can be left blank or not included.

Returns

A dictionary with a data property that contains an array of up to limit number of purchase orders, starting after page. Each entry in the data array is a separate number of purchase order object. If no more purchase orders are available, the resulting array will be empty.

ENDPOINTS

GET /purchase_orders/search_count/?token=:token&query=:query

REQUEST

GET /purchase_orders/search_count/?token=rapidapi-02928-29292-2991AA02-292&query=Roof%20Soleil HTTP/1.1
X-Rapidapi-Key: {RAPIDAPI-KEY}
X-Rapidapi-Host: government-purchase-orders-api.p.rapidapi.com
Host: government-purchase-orders-api.p.rapidapi.com

RESPONSE

{
  "status": "success",
  "code": 200,
  "message": "OK. Everything worked as expected.",
  "result": {
    "object": "search_result",
    "data": [
      {
        "total": "4",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Roof Soleil Ltd"
      },
      {
        "total": "2",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Goodwill Roofing & Cladding Ltd"
      }
    ],
    "pagination": {
      "total_records": 2,
      "current_page": 1,
      "next_page": 2,
      "previous_page": false,
      "records_per_page": "0",
      "total_pages": 0
    },
    "query": {
      "fields": "amount,organisation_name,supplier_name",
      "filters": {
        "organisation_name": "West Suffolk Council",
        "year": "2024",
        "month": "1"
      },
      "limit": "0",
      "offset": 0,
      "dataset": "government_purchase_orders",
      "order_by": "total desc",
      "group_by": "organisation_name,supplier_name"
    }
  }
}
Go to top

2.i. List Total Purchase Orders

Returns a list of total of purchase orders.

Test Endpoint

Authorisation

Requires Rapidapi Key for api authorisation.

Related guide: Authentication

Parameters

order_by string optional (can be left blank)

Return the Purchase Orders with the ordering specified. Can be left blank or not included.

Related guide: Ordering rows

Available fields list

total, total asc, total desc,id, id asc, id desc, organisation_name, organisation_name asc, organisation_name desc, supplier_name, supplier_name asc, supplier_name desc, amount, amount asc, amount desc, account_type, account_type asc, account_type desc, cost_centre, cost_centre asc, cost_centre desc, year, year asc, year desc, month, month asc, month desc, order_date, order_date asc, order_date desc, order_number, order_number asc, order_number desc, sovereign_state_name, sovereign_state_name asc, sovereign_state_name desc, country_name, country_name asc, country_name desc, region_name, region_name asc, region_name desc, area_name, area_name asc, area_name desc, county_name, county_name asc, county_name desc, district_name, district_name asc, district_name desc

group_by string optional (can be left blank)

Groups the Purchase Orders with the grouping specified. Can be left blank or not included.

Related guide: Grouping rows

Available fields list

id, name, organisation_name, supplier_name, account_type, cost_centre, amount, year, month, guid, month_name, order_number, sovereign_state_name, country_name, county_name, region_name, area_name, district_name, order_date, department_name, category_name, section_name, organisation_id, supplier_id

id integer filter optional (can be left blank)

Only return the Purchase Order for the identifier specified. Can be left blank or not included.

name string filter optional (can be left blank)

Only return the Purchase Order for the name specified. Can be left blank or not included.

organisation_name string filter optional (can be left blank)

Only return the Purchase Orders for the organisation name specified. Can be left blank or not included.

supplier_name string filter optional (can be left blank)

Only return the Purchase Orders for the supplier name specified. Can be left blank or not included.

account_type string filter optional (can be left blank)

Only return the Purchase Orders for the account type specified. Can be left blank or not included.

cost_centre string filter optional (can be left blank)

Only return the Purchase Orders for the cost centre specified. Can be left blank or not included.

amount float filter optional (can be left blank)

Only return the Purchase Orders for the amount specified. Can be left blank or not included.

year integer filter optional (can be left blank)

Only return the Purchase Orders for the year specified. Can be left blank or not included.

month integer filter optional (can be left blank)

Only return the Purchase Orders for the month specified. Can be left blank or not included.

guid string filter optional (can be left blank)

Only return the Purchase Orders for the Globally Unique Identifier specified. Can be left blank or not included.

month_name string filter optional (can be left blank)

Only return the Purchase Orders for the month name specified. Can be left blank or not included.

order_number string filter optional (can be left blank)

Only return the Purchase Orders for the order number specified. Can be left blank or not included.

sovereign_state_name string filter optional (can be left blank)

Only return the Purchase Orders for the sovereign state name specified. Can be left blank or not included.

country_name string filter optional (can be left blank)

Only return the Purchase Orders for the country name specified. Can be left blank or not included.

county_name string filter optional (can be left blank)

Only return the Purchase Orders for the county name specified. Can be left blank or not included.

region_name string filter optional (can be left blank)

Only return the Purchase Orders for the region name specified. Can be left blank or not included.

area_name string filter optional (can be left blank)

Only return the Purchase Orders for the area name specified. Can be left blank or not included.

district_name string filter optional (can be left blank)

Only return the Purchase Orders for the district name specified. Can be left blank or not included.

order_date string filter optional (can be left blank)

Only return the Purchase Orders for the order date specified. Can be left blank or not included.

department_name string filter optional (can be left blank)

Only return the Purchase Orders for the department name specified. Can be left blank or not included.

category_name string filter optional (can be left blank)

Only return the Purchase Orders for the category name specified. Can be left blank or not included.

section_name string filter optional (can be left blank)

Only return the Purchase Orders for the section name specified. Can be left blank or not included.

organisation_id string filter optional (can be left blank)

Only return the Purchase Orders for the organisation id specified. Can be left blank or not included.

supplier_id string filter optional (can be left blank)

Only return the Purchase Orders for the supplier id specified. Can be left blank or not included.

Returns

A dictionary with a data property that contains an array of up to limit total of purchase orders, starting after page. Each entry in the data array is a separate total of purchase order object. If no more purchase orders are available, the resulting array will be empty.

ENDPOINTS

GET /purchase_orders/list_total/?token=:token

REQUEST

GET /purchase_orders/list_total/?token=rapidapi-02928-29292-2991AA02-292 HTTP/1.1
X-Rapidapi-Key: {RAPIDAPI-KEY}
X-Rapidapi-Host: government-purchase-orders-api.p.rapidapi.com
Host: government-purchase-orders-api.p.rapidapi.com

RESPONSE

{
  "status": "success",
  "code": 200,
  "message": "OK. Everything worked as expected.",
  "result": {
    "object": "list",
    "data": [
      {
        "total": 30893215.24,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "RG Carter Southern Ltd"
      },
      {
        "total": 8367995.66,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Suffolk County Council"
      },
      {
        "total": 3603139.31,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "WFL (UK) Ltd t/a Hall Fuels"
      },
      {
        "total": 2945369.5,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "FAUN Zoeller (UK) Limited"
      },
      {
        "total": 2288365.59,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Roof Soleil Ltd"
      },
      {
        "total": 1593325.56,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "East Suffolk Council"
      },
      {
        "total": 1485312.81,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Projects & Feasibility",
        "supplier_name": "Pick Everard"
      },
      {
        "total": 1461425.67,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Concrete Repairs Limited"
      },
      {
        "total": 1329552.22,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "New Anglia Local Enterprise Partnership Ltd"
      },
      {
        "total": 1067598,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Flagship Homes"
      },
      {
        "total": 1032352.2,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Abbey Gardens",
        "supplier_name": "Pro-Scape Limited"
      },
      {
        "total": 1016615.02,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Off Street Car Parks",
        "supplier_name": "Cobalt Telephone Technologies Ltd"
      },
      {
        "total": 1002942.5,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Anglia Revenues Partnership",
        "supplier_name": "Breckland Council"
      },
      {
        "total": 955087.11,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Abbeycroft Leisure"
      },
      {
        "total": 881259,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "S & B Commercials Ltd T/A Orwell Truck & Van"
      },
      {
        "total": 819246,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Sports & Leisure Centres",
        "supplier_name": "Abbeycroft Leisure"
      },
      {
        "total": 735854.12,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "ICT",
        "supplier_name": "Bytes Software Services Ltd"
      },
      {
        "total": 728066.73,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Customer and Digital Services",
        "supplier_name": "Bytes Software Services Ltd"
      },
      {
        "total": 710491,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Bunce (Ashbury) Ltd"
      },
      {
        "total": 663022.3,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Anglia Revenues Partnership",
        "supplier_name": "Bytes Software Services Ltd"
      },
      {
        "total": 641937,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "P Tuckwell Ltd"
      },
      {
        "total": 632591.67,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Dell Corporation Ltd"
      },
      {
        "total": 595500,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Havebury Housing Partnership"
      },
      {
        "total": 582401.1,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "The Apex",
        "supplier_name": "CBRE Ltd (Client Accounts)"
      },
      {
        "total": 546707,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Corporate Expenditure",
        "supplier_name": "Ernst & Young LLP"
      },
      {
        "total": 508675,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Dennis Eagle Limited T/A Terberg Matec UK"
      },
      {
        "total": 506246,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Motus Commercials Limited (purchases)"
      },
      {
        "total": 502105.5,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Certas Energy UK Ltd"
      },
      {
        "total": 495437,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Lark Technology Group"
      },
      {
        "total": 485495,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "D J Sears Limited"
      },
      {
        "total": 474666.41,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Street Furniture",
        "supplier_name": "Suffolk County Council"
      },
      {
        "total": 451382.85,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Housing Options: Temporary Accommodation",
        "supplier_name": "CCCGC Ltd t/a Priory Hotel"
      },
      {
        "total": 449110,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Compostable Collection (Brown Bin)",
        "supplier_name": "Suffolk County Council"
      },
      {
        "total": 437772.18,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Off Street Car Parks",
        "supplier_name": "Flowbird Smart City Ltd"
      },
      {
        "total": 437531.97,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Motus Commercials Limited"
      },
      {
        "total": 431065.72,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Offices: West Suffolk House",
        "supplier_name": "Verse Facilities Management Limited"
      },
      {
        "total": 374144.08,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Kent County Council T/A LASER Energy Buying Group Kent County Council"
      },
      {
        "total": 359582.41,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "The Apex",
        "supplier_name": "TGC Concerts Ltd. t/a The Gig Cartel"
      },
      {
        "total": 347977,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Northern Commercials Ltd"
      },
      {
        "total": 326250,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "VANWISE GROUP LTD"
      },
      {
        "total": 324740,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Marshall Motor Group Ltd"
      },
      {
        "total": 320824.36,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "The Apex",
        "supplier_name": "CBRE Ltd"
      },
      {
        "total": 320527.69,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "CCTV",
        "supplier_name": "Truetech Integrated Ltd"
      },
      {
        "total": 312816,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Goodwill Roofing & Cladding Ltd"
      },
      {
        "total": 307588.29,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "The Apex",
        "supplier_name": "Performing Artiste"
      },
      {
        "total": 303911,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "West Suffolk NHS Foundation Trust"
      },
      {
        "total": 289215,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Projects & Feasibility",
        "supplier_name": "Currie & Brown UK Ltd"
      },
      {
        "total": 279578.1,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Joju Ltd (trading name: Joju Charging)"
      },
      {
        "total": 261875,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Currie & Brown UK Ltd"
      },
      {
        "total": 259575,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "NTM GB Ltd"
      },
      {
        "total": 248262.16,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Arthur J Gallagher Insurance Brokers Ltd"
      },
      {
        "total": 246000,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Legal Services",
        "supplier_name": "Babergh District Council"
      },
      {
        "total": 242509.05,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Off Street Car Parks",
        "supplier_name": "CBRE Ltd (Client Accounts)"
      },
      {
        "total": 242175.88,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Cadman Construction Ltd"
      },
      {
        "total": 237385,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Ernest Doe & Sons Ltd"
      },
      {
        "total": 235539.65,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Ustigate Limited"
      },
      {
        "total": 235480.1,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Refuse Collection: Black/Blue Bin",
        "supplier_name": "ESE World Ltd"
      },
      {
        "total": 233951,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "The Athenaeum",
        "supplier_name": "G J Bream Limited"
      },
      {
        "total": 230156.02,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Solar Farm",
        "supplier_name": "Greenheath Asset Management"
      },
      {
        "total": 227464.45,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "ICT",
        "supplier_name": "CAE Technology Services Ltd"
      },
      {
        "total": 227100,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Green Light Trust"
      },
      {
        "total": 225419.64,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Mixbrow Limited t/a Mixbrow Construction"
      },
      {
        "total": 218779.88,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Local Plan",
        "supplier_name": "The Planning Inspectorate"
      },
      {
        "total": 218282.86,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Other Parks and Play Provision",
        "supplier_name": "Verse Facilities Management Limited"
      },
      {
        "total": 215935.97,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "The Apex",
        "supplier_name": "Performing Artist"
      },
      {
        "total": 215450.65,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "East Fire Extinguishers & Alarms UK Ltd"
      },
      {
        "total": 214350.14,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Reesink UK Limited"
      },
      {
        "total": 211614.33,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "UrbanChain Ltd"
      },
      {
        "total": 211349.42,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Development Control",
        "supplier_name": "Essex County Council"
      },
      {
        "total": 208656.46,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Offices: Mildenhall Hub",
        "supplier_name": "Verse Facilities Management Limited"
      },
      {
        "total": 207747,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Sports and Leisure Centres",
        "supplier_name": "Abbeycroft Leisure"
      },
      {
        "total": 206362.64,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Refuse Collection (Black or Blue Bin)",
        "supplier_name": "ESE World Ltd"
      },
      {
        "total": 196818.22,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Housing Options: Temporary Accommodation",
        "supplier_name": "Home Group Limited"
      },
      {
        "total": 192087.03,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Lookers Group Fleet"
      },
      {
        "total": 191513.63,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "S&C Slatter"
      },
      {
        "total": 185678,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "West Suffolk College"
      },
      {
        "total": 184615.5,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Off Street Car Parks",
        "supplier_name": "D J Sears Limited"
      },
      {
        "total": 182517,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Emergency Planning",
        "supplier_name": "Suffolk County Council"
      },
      {
        "total": 180747.81,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "The Apex",
        "supplier_name": "Strictly Theatre Co Limited"
      },
      {
        "total": 180250,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Gravity Engineering Ltd"
      },
      {
        "total": 179917,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "VP-AV Ltd"
      },
      {
        "total": 179872.98,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Resources and Performance",
        "supplier_name": "Elysian Associates"
      },
      {
        "total": 177574.89,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Lifelink Project",
        "supplier_name": "NHS Suffolk & North East Essex ICB"
      },
      {
        "total": 177394.35,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "ICT",
        "supplier_name": "Dell Corporation Ltd"
      },
      {
        "total": 174264.53,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "NHS West Suffolk CCG"
      },
      {
        "total": 174238.79,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Housing Options: Outreach Services",
        "supplier_name": "Norfolk & Suffolk NHS Foundation Trust"
      },
      {
        "total": 166176.75,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Housing Options: Temporary Accommodation",
        "supplier_name": "Oakpark Security Systems Ltd"
      },
      {
        "total": 156448.89,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Asphalt Reinforcement Services Ltd"
      },
      {
        "total": 154616.5,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Watling JCB Ltd"
      },
      {
        "total": 153812.5,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Development Control",
        "supplier_name": "Cornerstone Barristers"
      },
      {
        "total": 153297,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Hako Machines Ltd"
      },
      {
        "total": 153068,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Babergh and Mid Suffolk CPE",
        "supplier_name": "Babergh District Council"
      },
      {
        "total": 152626.21,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Wicksteed Leisure Limited"
      },
      {
        "total": 148351.87,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Property Services",
        "supplier_name": "Civica UK Limited"
      },
      {
        "total": 144192.84,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "West Suffolk Operational Hub",
        "supplier_name": "Cargate Engineering Limited"
      },
      {
        "total": 144125.92,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Bytes Software Services Ltd"
      },
      {
        "total": 144000,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Other Public Health Services",
        "supplier_name": "West End Rehoming Ltd"
      },
      {
        "total": 137794.16,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Non-Distributed Costs",
        "supplier_name": "Suffolk County Council"
      },
      {
        "total": 137741.65,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Industrial & Business Units",
        "supplier_name": "Goodwill Roofing & Cladding Ltd"
      },
      {
        "total": 132570.16,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Offices: College Heath Road",
        "supplier_name": "SRC Aggregates Limited"
      }
    ],
    "pagination": {
      "total_records": 1044,
      "current_page": 1,
      "next_page": 2,
      "previous_page": false,
      "records_per_page": "100",
      "total_pages": 11
    },
    "query": {
      "fields": "amount,organisation_name,cost_centre,supplier_name",
      "filters": {
        "organisation_name": "West Suffolk Council"
      },
      "limit": "100",
      "offset": 0,
      "dataset": "government_purchase_orders",
      "order_by": "total desc",
      "group_by": "organisation_name,cost_centre,supplier_name"
    }
  }
}
Go to top

2.j. Search Total Purchase Orders

Returns a list of total of purchase orders given a search query string.

Test Endpoint

Authorisation

Requires Rapidapi Key for api authorisation.

Related guide: Authentication

Parameters

query string required

The search query string.

order_by string optional (can be left blank)

Return the Purchase Orders with the ordering specified. Can be left blank or not included.

Related guide: Ordering rows

Available fields list

total,total asc,total desc,id, id asc, id desc, organisation_name, organisation_name asc, organisation_name desc, supplier_name, supplier_name asc, supplier_name desc, amount, amount asc, amount desc, account_type, account_type asc, account_type desc, cost_centre, cost_centre asc, cost_centre desc, year, year asc, year desc, month, month asc, month desc, order_date, order_date asc, order_date desc, order_number, order_number asc, order_number desc, sovereign_state_name, sovereign_state_name asc, sovereign_state_name desc, country_name, country_name asc, country_name desc, region_name, region_name asc, region_name desc, area_name, area_name asc, area_name desc, county_name, county_name asc, county_name desc, district_name, district_name asc, district_name desc

group_by string optional (can be left blank)

Groups the Purchase Orders with the grouping specified. Can be left blank or not included.

Related guide: Grouping rows

Available fields list

id, name, organisation_name, supplier_name, account_type, cost_centre, amount, year, month, guid, month_name, order_number, sovereign_state_name, country_name, county_name, region_name, area_name, district_name, order_date, department_name, category_name, section_name, organisation_id, supplier_id

id integer filter optional (can be left blank)

Only return the Purchase Order for the identifier specified. Can be left blank or not included.

name string filter optional (can be left blank)

Only return the Purchase Order for the name specified. Can be left blank or not included.

organisation_name string filter optional (can be left blank)

Only return the Purchase Orders for the organisation name specified. Can be left blank or not included.

supplier_name string filter optional (can be left blank)

Only return the Purchase Orders for the supplier name specified. Can be left blank or not included.

account_type string filter optional (can be left blank)

Only return the Purchase Orders for the account type specified. Can be left blank or not included.

cost_centre string filter optional (can be left blank)

Only return the Purchase Orders for the cost centre specified. Can be left blank or not included.

amount float filter optional (can be left blank)

Only return the Purchase Orders for the amount specified. Can be left blank or not included.

year integer filter optional (can be left blank)

Only return the Purchase Orders for the year specified. Can be left blank or not included.

month integer filter optional (can be left blank)

Only return the Purchase Orders for the month specified. Can be left blank or not included.

guid string filter optional (can be left blank)

Only return the Purchase Orders for the Globally Unique Identifier specified. Can be left blank or not included.

month_name string filter optional (can be left blank)

Only return the Purchase Orders for the month name specified. Can be left blank or not included.

order_number string filter optional (can be left blank)

Only return the Purchase Orders for the order number specified. Can be left blank or not included.

sovereign_state_name string filter optional (can be left blank)

Only return the Purchase Orders for the sovereign state name specified. Can be left blank or not included.

country_name string filter optional (can be left blank)

Only return the Purchase Orders for the country name specified. Can be left blank or not included.

county_name string filter optional (can be left blank)

Only return the Purchase Orders for the county name specified. Can be left blank or not included.

region_name string filter optional (can be left blank)

Only return the Purchase Orders for the region name specified. Can be left blank or not included.

area_name string filter optional (can be left blank)

Only return the Purchase Orders for the area name specified. Can be left blank or not included.

district_name string filter optional (can be left blank)

Only return the Purchase Orders for the district name specified. Can be left blank or not included.

order_date string filter optional (can be left blank)

Only return the Purchase Orders for the order date specified. Can be left blank or not included.

department_name string filter optional (can be left blank)

Only return the Purchase Orders for the department name specified. Can be left blank or not included.

category_name string filter optional (can be left blank)

Only return the Purchase Orders for the category name specified. Can be left blank or not included.

section_name string filter optional (can be left blank)

Only return the Purchase Orders for the section name specified. Can be left blank or not included.

organisation_id string filter optional (can be left blank)

Only return the Purchase Orders for the organisation id specified. Can be left blank or not included.

supplier_id string filter optional (can be left blank)

Only return the Purchase Orders for the supplier id specified. Can be left blank or not included.

Returns

A dictionary with a data property that contains an array of up to limit total of purchase orders, starting after page. Each entry in the data array is a separate total of purchase order object. If no more purchase orders are available, the resulting array will be empty.

ENDPOINTS

GET /purchase_orders/search_total/?token=:token&query=:query

REQUEST

GET /purchase_orders/search_total/?token=rapidapi-02928-29292-2991AA02-292&query=Roof%20Soleil HTTP/1.1
X-Rapidapi-Key: {RAPIDAPI-KEY}
X-Rapidapi-Host: government-purchase-orders-api.p.rapidapi.com
Host: government-purchase-orders-api.p.rapidapi.com

RESPONSE

{
  "status": "success",
  "code": 200,
  "message": "OK. Everything worked as expected.",
  "result": {
    "object": "search_result",
    "data": [
      {
        "total": 2288365.59,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Roof Soleil Ltd"
      },
      {
        "total": 312816,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "Goodwill Roofing & Cladding Ltd"
      },
      {
        "total": 137741.65,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Industrial & Business Units",
        "supplier_name": "Goodwill Roofing & Cladding Ltd"
      },
      {
        "total": 94096,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Industrial and Business Units",
        "supplier_name": "Goodwill Roofing & Cladding Ltd"
      },
      {
        "total": 77503,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "The Athenaeum",
        "supplier_name": "G J Bream Limited"
      },
      {
        "total": 59857,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Environmental Management",
        "supplier_name": "Roof Soleil Ltd"
      },
      {
        "total": 51655,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Vicon House",
        "supplier_name": "Goodwill Roofing & Cladding Ltd"
      },
      {
        "total": 15688.06,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Sports & Leisure Centres",
        "supplier_name": "S & G Industrial Roofing Ltd"
      },
      {
        "total": 10850,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Ehringhausen Way, Haverhill",
        "supplier_name": "Goodwill Roofing & Cladding Ltd"
      },
      {
        "total": 10000,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Sports and Leisure Centres",
        "supplier_name": "Goodwill Roofing & Cladding Ltd"
      },
      {
        "total": 9870,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Industrial and Business Units",
        "supplier_name": "Novus Property Solutions Ltd"
      },
      {
        "total": 9800,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Moyse's Hall Museum",
        "supplier_name": "P J Nichols t/a Aceflat Roofing"
      },
      {
        "total": 9500,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Offices: West Suffolk House",
        "supplier_name": "Roof Soleil Ltd"
      },
      {
        "total": 9345,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Balance Sheet",
        "supplier_name": "P J Nichols t/a Aceflat Roofing"
      },
      {
        "total": 8688,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Abbey Gardens",
        "supplier_name": "P J Nichols t/a Aceflat Roofing"
      },
      {
        "total": 7275,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Sports & Leisure Centres",
        "supplier_name": "Goodwill Roofing & Cladding Ltd"
      },
      {
        "total": 6964.6,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Industrial and Business Units",
        "supplier_name": "Roof Soleil Ltd"
      },
      {
        "total": 6780,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Environmental Management",
        "supplier_name": "Greenscape Energy Ltd"
      },
      {
        "total": 6694,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Moyse's Hall Museum",
        "supplier_name": "Lark Technology Group"
      },
      {
        "total": 5550,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Bury Bus Station",
        "supplier_name": "Goodwill Roofing & Cladding Ltd"
      },
      {
        "total": 5104,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "The Athenaeum",
        "supplier_name": "Goodwill Roofing & Cladding Ltd"
      },
      {
        "total": 5032.13,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Nowton Park",
        "supplier_name": "ADCO Construction Ltd"
      },
      {
        "total": 5000,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Nowton Park",
        "supplier_name": "P J Nichols t/a Aceflat Roofing"
      },
      {
        "total": 5000,
        "organisation_name": "West Suffolk Council",
        "cost_centre": "Offices: West Suffolk House",
        "supplier_name": "Goodwill Roofing & Cladding Ltd"
      }
    ],
    "pagination": {
      "total_records": 24,
      "current_page": 1,
      "next_page": false,
      "previous_page": false,
      "records_per_page": "100",
      "total_pages": 1
    },
    "query": {
      "fields": "amount,organisation_name,cost_centre,supplier_name",
      "filters": {
        "organisation_name": "West Suffolk Council"
      },
      "limit": "100",
      "offset": 0,
      "dataset": "government_purchase_orders",
      "order_by": "total desc",
      "group_by": "organisation_name,cost_centre,supplier_name"
    }
  }
}
Go to top

3.a. Organisations

Organisations describe the information about the government organisations that have placed Purchase orders for items and services.

ENDPOINTS

GET /organisations/id/?token=:token&id=:id
GET /organisations/name/?token=:token&name=:name
GET /organisations/list/?token=:token
GET /organisations/search/?token=:token&query=:query
Go to top

3.b. The Organisation Object

Attributes

organisation_name string

Name of the organisation or local authority

source_name string

Name of the source of information

source_url string

URL of the source of information

licence_name string

Name of licence

licence_url string

URL of licence

sovereign_state_name string

Sovereign state name of organisation. For example United Kingdom

country_name string

Country name of organisation. For example England, Scotland

region_name string

Region name of organisation. For example East of England

area_name string

Area name of organisation. For example East Anglia

county_name string

County name of organisation. For example Suffolk

district_name string

District name of organisation. For example West Suffolk District

organisation_address_line_1 string

Address line 1 of organisation

organisation_address_line_2 string

Address line 2 of organisation

organisation_town_city_name string

Town or city name of organisation

organisation_county_name string

County name of organisation

organisation_region_name string

Region name of organisation

organisation_postcode string

Postcode of organisation

organisation_country_name string

Country name of organisation

organisation_sovereign_state_name string

Sovereign state name of organisation

organisation_url string

URL of organisation

organisation_procurement_url string

Procurement URL of organisation

organisation_telephone_number string

Telephone number of organisation

organisation_email_address string

Email address of organisation

organisation_facebook_url string

Facebook profile URL of organisation

organisation_youtube_url string

Youtube profile URL of organisation

organisation_instagram_url string

Instagram profile URL of organisation

organisation_x_url string

X profile URL of organisation

organisation_tiktok_url string

TikTok profile URL of organisation

organisation_linkedin_url string

Linkedin profile URL of organisation

organisation_latitude string

Latitude coordinates of organisation address

organisation_longitude string

Longitude coordinates of organisation address

organisation_id string

Organisation id

the organisation object

 {
      "organisation_name": "West Suffolk Council",
      "source_name": "West Suffolk Council",
      "source_url": "https://www.westsuffolk.gov.uk/",
      "licence_name": "Open Government Licence (OGL)",
      "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
      "sovereign_state_name": "United Kingdom",
      "country_name": "England",
      "region_name": "East of England",
      "area_name": "East Anglia",
      "county_name": "Suffolk",
      "district_name": "West Suffolk District",
      "organisation_address_line_1": "West Suffolk House",
      "organisation_address_line_2": "Western Way",
      "organisation_town_city_name": "Bury St Edmunds",
      "organisation_county_name": "Suffolk",
      "organisation_region_name": "East of England",
      "organisation_postcode": "IP33 3YU",
      "organisation_country_name": "England",
      "organisation_sovereign_state_name": "United Kingdom",
      "organisation_url": "https://www.westsuffolk.gov.uk",
      "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
      "organisation_telephone_number": "01284 757310",
      "organisation_email_address": "procurement@westsuffolk.gov.uk",
      "organisation_facebook_url": "https://www.facebook.com/WestS",
      "organisation_youtube_url": "",
      "organisation_instagram_url": "https://www.instagram.com/west",
      "organisation_x_url": "https://twitter.com/west_suffo",
      "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
      "organisation_linkedin_url": "",
      "organisation_latitude": "52.251474",
      "organisation_longitude": "0.697005",
      "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5"
    }
Go to top

3.c. Get Organisation By Id

Retrieves the organisation object with the given identifier.

Test Endpoint

Authorisation

Requires Rapidapi Key for api authorisation.

Related guide: Authentication

Parameters

id integer required

Unique identifier for the object in numeric format.

fields string optional (can be left blank)

Only return the Organisations with the list of fields specified. Default is * or all available fields are returned. Can be left blank or not included.

Available fields list

*, organisation_name, source_name, source_url, licence_name, licence_url, sovereign_state_name, country_name, region_name, area_name, county_name, district_name, organisation_address_line_1,  organisation_address_line_2, organisation_town_city_name, organisation_county_name, organisation_region_name, organisation_postcode, organisation_country_name, organisation_sovereign_state_name, organisation_url, organisation_procurement_url, organisation_telephone_number, organisation_email_address, organisation_facebook_url, organisation_youtube_url, organisation_instagram_url, organisation_x_url, organisation_tiktok_url, organisation_linkedin_url, organisation_latitude, organisation_longitude, organisation_id

Related guide: Selecting fields

Returns

Returns a organisation object if a valid identifier was provided.

ENDPOINTS

GET /organisations/id/?token=:token&id=:id

REQUEST

GET /organisations/id/?token=rapidapi-02928-29292-2991AA02-292&id=7bbf6aca547766747347d63b7ff9e7b5 HTTP/1.1
X-Rapidapi-Key: {RAPIDAPI-KEY}
X-Rapidapi-Host: government-purchase-orders-api.p.rapidapi.com
Host: government-purchase-orders-api.p.rapidapi.com

RESPONSE

{
  "status": "success",
  "code": 200,
  "message": "OK. Everything worked as expected.",
  "result": {
    "object": "organisation",
    "data": {
      "organisation_name": "West Suffolk Council",
      "source_name": "West Suffolk Council",
      "source_url": "https://www.westsuffolk.gov.uk/",
      "licence_name": "Open Government Licence (OGL)",
      "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
      "sovereign_state_name": "United Kingdom",
      "country_name": "England",
      "region_name": "East of England",
      "area_name": "East Anglia",
      "county_name": "Suffolk",
      "district_name": "West Suffolk District",
      "organisation_address_line_1": "West Suffolk House",
      "organisation_address_line_2": "Western Way",
      "organisation_town_city_name": "Bury St Edmunds",
      "organisation_county_name": "Suffolk",
      "organisation_region_name": "East of England",
      "organisation_postcode": "IP33 3YU",
      "organisation_country_name": "England",
      "organisation_sovereign_state_name": "United Kingdom",
      "organisation_url": "https://www.westsuffolk.gov.uk",
      "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
      "organisation_telephone_number": "01284 757310",
      "organisation_email_address": "procurement@westsuffolk.gov.uk",
      "organisation_facebook_url": "https://www.facebook.com/WestS",
      "organisation_youtube_url": "",
      "organisation_instagram_url": "https://www.instagram.com/west",
      "organisation_x_url": "https://twitter.com/west_suffo",
      "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
      "organisation_linkedin_url": "",
      "organisation_latitude": "52.251474",
      "organisation_longitude": "0.697005",
      "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5"
    },
    "query": {
      "fields": "*",
      "filters": {
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5"
      },
      "limit": 1,
      "offset": 1,
      "dataset": "government_purchase_orders",
      "order_by": "organisation_id",
      "group_by": "organisation_id"
    }
  }
}
Go to top

3.d. Get Organisation By Name

Retrieves the organisation object with the given name.

Authorisation

Requires Rapidapi Key for api authorisation.

Related guide: Authentication

Parameters

name string required

Unique name for the object in string format.

fields string optional (can be left blank)

Only return the Organisations with the list of fields specified. Default is * or all available fields are returned. Can be left blank or not included.

Available fields list

*, organisation_name, source_name, source_url, licence_name, licence_url, sovereign_state_name, country_name, region_name, area_name, county_name, district_name, organisation_address_line_1,  organisation_address_line_2, organisation_town_city_name, organisation_county_name, organisation_region_name, organisation_postcode, organisation_country_name, organisation_sovereign_state_name, organisation_url, organisation_procurement_url, organisation_telephone_number, organisation_email_address, organisation_facebook_url, organisation_youtube_url, organisation_instagram_url, organisation_x_url, organisation_tiktok_url, organisation_linkedin_url, organisation_latitude, organisation_longitude, organisation_id

Related guide: Selecting fields

Returns

Returns a organisation object if a valid identifier was provided.

ENDPOINTS

GET /organisations/name/?token=:token&name=:name

REQUEST

GET /organisations/name/?token=rapidapi-02928-29292-2991AA02-292&name=West Suffolk Council HTTP/1.1
X-Rapidapi-Key: {RAPIDAPI-KEY}
X-Rapidapi-Host: government-purchase-orders-api.p.rapidapi.com
Host: government-purchase-orders-api.p.rapidapi.com

RESPONSE

{
  "status": "success",
  "code": 200,
  "message": "OK. Everything worked as expected.",
  "result": {
    "object": "organisation",
    "data": {
      "organisation_name": "West Suffolk Council",
      "source_name": "West Suffolk Council",
      "source_url": "https://www.westsuffolk.gov.uk/",
      "licence_name": "Open Government Licence (OGL)",
      "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
      "sovereign_state_name": "United Kingdom",
      "country_name": "England",
      "region_name": "East of England",
      "area_name": "East Anglia",
      "county_name": "Suffolk",
      "district_name": "West Suffolk District",
      "organisation_address_line_1": "West Suffolk House",
      "organisation_address_line_2": "Western Way",
      "organisation_town_city_name": "Bury St Edmunds",
      "organisation_county_name": "Suffolk",
      "organisation_region_name": "East of England",
      "organisation_postcode": "IP33 3YU",
      "organisation_country_name": "England",
      "organisation_sovereign_state_name": "United Kingdom",
      "organisation_url": "https://www.westsuffolk.gov.uk",
      "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
      "organisation_telephone_number": "01284 757310",
      "organisation_email_address": "procurement@westsuffolk.gov.uk",
      "organisation_facebook_url": "https://www.facebook.com/WestS",
      "organisation_youtube_url": "",
      "organisation_instagram_url": "https://www.instagram.com/west",
      "organisation_x_url": "https://twitter.com/west_suffo",
      "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
      "organisation_linkedin_url": "",
      "organisation_latitude": "52.251474",
      "organisation_longitude": "0.697005",
      "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5"
    },
    "query": {
      "fields": "*",
      "filters": {
        "organisation_name": "West Suffolk Council"
      },
      "limit": 1,
      "offset": 1,
      "dataset": "government_purchase_orders",
      "order_by": "organisation_name",
      "group_by": "organisation_name"
    }
  }
}
Go to top

3.e. List Organisations

Returns a list of organisations.

Test Endpoint

Authorisation

Requires Rapidapi Key for api authorisation.

Related guide: Authentication

Parameters

fields string optional (can be left blank)

Only return the Organisations with the list of fields specified. By default * or all available fields are returned. Can be left blank or not included.

Related guide: Selecting fields

Available fields list

*, organisation_name, source_name, source_url, licence_name, licence_url, sovereign_state_name, country_name, region_name, area_name, county_name, district_name, organisation_address_line_1, organisation_address_line_2, organisation_town_city_name, organisation_county_name, organisation_region_name, organisation_postcode, organisation_country_name, organisation_sovereign_state_name, organisation_url, organisation_procurement_url, organisation_telephone_number, organisation_email_address, organisation_facebook_url, organisation_youtube_url, organisation_instagram_url, organisation_x_url, organisation_tiktok_url, organisation_linkedin_url, organisation_latitude, organisation_longitude, organisation_id

order_by string optional (can be left blank)

Return the Organisations with the ordering specified. Can be left blank or not included.

Related guide: Ordering rows

Available fields list

organisation_id, organisation_id asc, organisation_id desc, organisation_name, organisation_name asc, organisation_name desc, sovereign_state_name, sovereign_state_name asc, sovereign_state_name desc, country_name, country_name asc, country_name desc, region_name, region_name asc, region_name desc, area_name, area_name asc, area_name desc, county_name, county_name asc, county_name desc, district_name, district_name asc, district_name desc

group_by string optional (can be left blank)

Groups the Organisations with the grouping specified. Can be left blank or not included.

Related guide: Grouping rows

Available fields list

organisation_name, sovereign_state_name, country_name, county_name, region_name, area_name, district_name, organisation_id

organisation_name string optional (can be left blank)

Only return the Organisation for the name specified. Can be left blank or not included.

sovereign_state_name string optional (can be left blank)

Only return the Organisations for the sovereign state name specified. Can be left blank or not included.

country_name string optional (can be left blank)

Only return the Organisations for the country name specified. Can be left blank or not included.

county_name string optional (can be left blank)

Only return the Organisations for the county name specified. Can be left blank or not included.

region_name string optional (can be left blank)

Only return the Organisations for the region name specified. Can be left blank or not included.

area_name string optional (can be left blank)

Only return the Organisations for the area name specified. Can be left blank or not included.

district_name string optional (can be left blank)

Only return the Organisations for the district name specified. Can be left blank or not included.

organisation_id string optional (can be left blank)

Only return the Organisations for the organisation id specified. Can be left blank or not included.

supplier_name string optional (can be left blank)

Only return the Organisations for the supplier name specified. Can be left blank or not included.

supplier_id string optional (can be left blank)

Only return the Organisations for the supplier id specified. Can be left blank or not included.

Returns

A dictionary with a data property that contains an array of up to limit organisations, starting after page. Each entry in the data array is a separate organisation object. If no more organisations are available, the resulting array will be empty.

ENDPOINTS

GET /organisations/list/?token=:token

REQUEST

GET /organisations/list/?token=rapidapi-02928-29292-2991AA02-292 HTTP/1.1
X-Rapidapi-Key: {RAPIDAPI-KEY}
X-Rapidapi-Host: government-purchase-orders-api.p.rapidapi.com
Host: government-purchase-orders-api.p.rapidapi.com

RESPONSE

{
  "status": "success",
  "code": 200,
  "message": "OK. Everything worked as expected.",
  "result": {
    "object": "list",
    "data": [
      {
        "name": "3e8e97e78239d166191aee72eb49e55f",
        "id": "1",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "RG Carter Southern Ltd",
        "account_type": "Capital Expenditure",
        "cost_centre": "Balance Sheet",
        "description": "Mildenhall Hub - Payment Certificate",
        "amount": "390725",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "3e8e97e78239d166191aee72eb49e55f",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050488",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "a86a8ea28d493dc9863cdb4dfe2e9918"
      },
      {
        "name": "407dbc3a2fdb7f69e94736378f2416f5",
        "id": "2",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Local Government Association",
        "account_type": "Subscriptions",
        "cost_centre": "Corporate Expenditure",
        "description": "LGA Membership Subscription",
        "amount": "10450",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "407dbc3a2fdb7f69e94736378f2416f5",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8051073",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "cf8159e706828b60449192be2c998b1e"
      },
      {
        "name": "3d304776301b1bf7c5863fd5b6714d75",
        "id": "3",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Cale Access UK Ltd",
        "account_type": "TPP - Other",
        "cost_centre": "Off Street Car Parks",
        "description": "MP104 to CWT-C Upgrade",
        "amount": "9032",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "3d304776301b1bf7c5863fd5b6714d75",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050360",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "8ae1369f29aea431ad5eb0277991bb7c"
      },
      {
        "name": "31c2ee04b5cc16d3e8408eeebd4f8627",
        "id": "4",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Cobalt Telephone Technologies Ltd",
        "account_type": "Services - Fees and Charges",
        "cost_centre": "Off Street Car Parks",
        "description": "SEBC RingGo Fee",
        "amount": "7132.98",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "31c2ee04b5cc16d3e8408eeebd4f8627",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050797",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "df415080e831ac7f9138fbb1edc46393"
      },
      {
        "name": "5210274d952c1be5f6b7cf152a08b2d4",
        "id": "5",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Truetech Integrated Ltd",
        "account_type": "TPP - Other",
        "cost_centre": "Off Street Car Parks",
        "description": "Body Cameras",
        "amount": "7432.8",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "5210274d952c1be5f6b7cf152a08b2d4",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050963",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "de8fdd823ae9f427a1ece1c63ee18c37"
      },
      {
        "name": "c42b9cc8d1bf66b04c40d00724f3f2d6",
        "id": "6",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Modern Mindset Ltd",
        "account_type": "Computing - Purchase of Hardware",
        "cost_centre": "Democratic Services",
        "description": "modern.gov",
        "amount": "10250",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "c42b9cc8d1bf66b04c40d00724f3f2d6",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050436",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "1ee2fdd8b560bbcfa7927d30d52587f5"
      },
      {
        "name": "4495daae0c1033ae1658447b05ebd420",
        "id": "7",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Greencells GmbH",
        "account_type": "R & M of Plant & Equipment",
        "cost_centre": "Solar Farm",
        "description": "R & M of Plant & Equipment",
        "amount": "5290",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "4495daae0c1033ae1658447b05ebd420",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050649",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "ba6f1610d572201a8c0d3520b0c591ec"
      },
      {
        "name": "5e47087640d45414a3148016e5d37143",
        "id": "8",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "United Stage International Limited",
        "account_type": "Artistes/Performers Fees",
        "cost_centre": "Bury Festival",
        "description": "Artiste Fees",
        "amount": "8000",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "5e47087640d45414a3148016e5d37143",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050952",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "0b6efc158a700a107b01ca2ed68121d0"
      },
      {
        "name": "4ccd8c159cec5cc848b32795b97b1a73",
        "id": "9",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "Hazard Chase Limited",
        "account_type": "Artistes/Performers Fees",
        "cost_centre": "Bury Festival",
        "description": "Artiste Fees",
        "amount": "7850",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "4ccd8c159cec5cc848b32795b97b1a73",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050955",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "a70a522bdc27065bfa4aceaa73cdaa6f"
      },
      {
        "name": "02c38584d5312d2deaf4bb95ae68a86a",
        "id": "10",
        "organisation_name": "West Suffolk Council",
        "supplier_name": "WFL (UK) Ltd t/a Hall Fuels",
        "account_type": "Stock - For Internal Use",
        "cost_centre": "Balance Sheet",
        "description": "Fuel for BSE",
        "amount": "14278.22",
        "year": "2019",
        "month": "4",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "guid": "02c38584d5312d2deaf4bb95ae68a86a",
        "updated_date": "2025-02-03 12:56:59",
        "created_date": "2025-02-03 12:56:59",
        "month_name": "April",
        "order_number": "8050633",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "currency_symbol": "£",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "order_date": "2019-04-01",
        "department_name": "Goods and Services",
        "category_name": "Goods and Services",
        "section_name": "Goods and Services",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5",
        "supplier_id": "1693e2b09d4ceddd19873d51930bc684"
      }
    ],
    "pagination": {
      "total_records": "417",
      "current_page": 1,
      "next_page": 2,
      "previous_page": false,
      "records_per_page": "10",
      "total_pages": 42
    },
    "query": {
      "fields": "*",
      "filters": [],
      "limit": "10",
      "offset": 0,
      "dataset": "government_purchase_orders",
      "order_by": "id",
      "group_by": "id"
    }
  }
}
Go to top

3.f. Search Organisations

Returns a list of organisations given a search query string.

Test Endpoint

Authorisation

Requires Rapidapi Key for api authorisation.

Related guide: Authentication

Parameters

query string required

The search query string.

fields string optional (can be left blank)

Only return the Organisations with the list of fields specified. By default * or all available fields are returned.. Can be left blank or not included.

Related guide: Selecting fields

Available fields list

*, organisation_name, source_name, source_url, licence_name, licence_url, sovereign_state_name, country_name, region_name, area_name, county_name, district_name, organisation_address_line_1, organisation_address_line_2, organisation_town_city_name, organisation_county_name, organisation_region_name, organisation_postcode, organisation_country_name, organisation_sovereign_state_name, organisation_url, organisation_procurement_url, organisation_telephone_number, organisation_email_address, organisation_facebook_url, organisation_youtube_url, organisation_instagram_url, organisation_x_url, organisation_tiktok_url, organisation_linkedin_url, organisation_latitude, organisation_longitude, organisation_id

order_by string optional (can be left blank)

Return the Organisations with the ordering specified. Can be left blank or not included.

Related guide: Ordering rows

Available fields list

organisation_id, organisation_id asc, organisation_id desc, organisation_name, organisation_name asc, organisation_name desc, sovereign_state_name, sovereign_state_name asc, sovereign_state_name desc, country_name, country_name asc, country_name desc, region_name, region_name asc, region_name desc, area_name, area_name asc, area_name desc, county_name, county_name asc, county_name desc, district_name, district_name asc, district_name desc

group_by string optional (can be left blank)

Groups the Organisations with the grouping specified. Can be left blank or not included.

Related guide: Grouping rows

Available fields list

organisation_name, sovereign_state_name, country_name, county_name, region_name, area_name, district_name, organisation_id

organisation_name string optional (can be left blank)

Only return the Organisation for the name specified. Can be left blank or not included.

sovereign_state_name string optional (can be left blank)

Only return the Organisations for the sovereign state name specified. Can be left blank or not included.

country_name string optional (can be left blank)

Only return the Organisations for the country name specified. Can be left blank or not included.

county_name string optional (can be left blank)

Only return the Organisations for the county name specified. Can be left blank or not included.

region_name string optional (can be left blank)

Only return the Organisations for the region name specified. Can be left blank or not included.

area_name string optional (can be left blank)

Only return the Organisations for the area name specified. Can be left blank or not included.

district_name string optional (can be left blank)

Only return the Organisations for the district name specified. Can be left blank or not included.

organisation_id string optional (can be left blank)

Only return the Organisations for the organisation id specified. Can be left blank or not included.

supplier_name string optional (can be left blank)

Only return the Organisations for the supplier name specified. Can be left blank or not included.

supplier_id string optional (can be left blank)

Only return the Organisations for the supplier id specified. Can be left blank or not included.

Returns

A dictionary with a data property that contains an array of up to limit organisations, starting after page. Each entry in the data array is a separate organisation object. If no more organisations are available, the resulting array will be empty.

ENDPOINTS

GET /organisations/search/?token=:token&query=:query

REQUEST

GET /organisations/search/?token=rapidapi-02928-29292-2991AA02-292&query=Suffolk HTTP/1.1
X-Rapidapi-Key: {RAPIDAPI-KEY}
X-Rapidapi-Host: government-purchase-orders-api.p.rapidapi.com
Host: government-purchase-orders-api.p.rapidapi.com

RESPONSE

{
  "status": "success",
  "code": 200,
  "message": "OK. Everything worked as expected.",
  "result": {
    "object": "search_result",
    "data": [
      {
        "organisation_name": "West Suffolk Council",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "organisation_address_line_1": "West Suffolk House",
        "organisation_address_line_2": "Western Way",
        "organisation_town_city_name": "Bury St Edmunds",
        "organisation_county_name": "Suffolk",
        "organisation_region_name": "East of England",
        "organisation_postcode": "IP33 3YU",
        "organisation_country_name": "England",
        "organisation_sovereign_state_name": "United Kingdom",
        "organisation_url": "https://www.westsuffolk.gov.uk",
        "organisation_procurement_url": "https://www.westsuffolk.gov.uk/community/townandparishguideprocurement.cfm",
        "organisation_telephone_number": "01284 757310",
        "organisation_email_address": "procurement@westsuffolk.gov.uk",
        "organisation_facebook_url": "https://www.facebook.com/WestS",
        "organisation_youtube_url": "",
        "organisation_instagram_url": "https://www.instagram.com/west",
        "organisation_x_url": "https://twitter.com/west_suffo",
        "organisation_tiktok_url": "https://www.tiktok.com/@westsu",
        "organisation_linkedin_url": "",
        "organisation_latitude": "52.251474",
        "organisation_longitude": "0.697005",
        "organisation_id": "7bbf6aca547766747347d63b7ff9e7b5"
      }
    ],
    "pagination": {
      "total_records": "1",
      "current_page": 1,
      "next_page": false,
      "previous_page": false,
      "records_per_page": "10",
      "total_pages": 1
    },
    "query": {
      "fields": "*, organisation_id",
      "query": "Suffolk",
      "filters": [],
      "limit": "10",
      "offset": 0,
      "dataset": "government_purchase_orders",
      "order_by": "district_name desc",
      "group_by": "organisation_id",
      "query_filters": [
        "organisation_name",
        "sovereign_state_name",
        "country_name",
        "region_name",
        "area_name",
        "county_name",
        "district_name",
        "organisation_id"
      ]
    }
  }
}
Go to top

4.a. Suppliers

Suppliers describe the information about the vendors that have fulfilled government organisations Purchase orders for items and services.

ENDPOINTS

GET /suppliers/id/?token=:token&id=:id 
GET /suppliers/name/?token=:token&name=:name
GET /suppliers/list/?token=:token
GET /suppliers/search/?token=:token&query=:query
Go to top

4.b. The Supplier Object

Attributes

supplier_name string

Name of the supplier

source_name string

Name of the source of information

source_url string

URL of the source of information

licence_name string

Name of licence

licence_url string

URL of licence

sovereign_state_name string

Sovereign state name of organisation. For example United Kingdom

country_name string

Country name of organisation. For example England, Scotland

region_name string

Region name of organisation. For example East of England

area_name string

Area name of organisation. For example East Anglia

county_name string

County name of organisation. For example Suffolk

district_name string

District name of organisation. For example West Suffolk District

supplier_id string

Supplier id

the supplier object

{
      "supplier_name": "RG Carter Southern Ltd",
      "source_name": "West Suffolk Council",
      "source_url": "https://www.westsuffolk.gov.uk/",
      "licence_name": "Open Government Licence (OGL)",
      "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
      "sovereign_state_name": "United Kingdom",
      "country_name": "England",
      "region_name": "East of England",
      "area_name": "East Anglia",
      "county_name": "Suffolk",
      "district_name": "West Suffolk District",
      "supplier_id": "a86a8ea28d493dc9863cdb4dfe2e9918"
    }
Go to top

4.c. Get Supplier By Id

Retrieves the supplier object with the given identifier.

Test Endpoint

Authorisation

Requires Rapidapi Key for api authorisation.

Related guide: Authentication

Parameters

id integer required

Unique identifier for the object in numeric format.

fields string optional (can be left blank)

Only return the Supplier with the list of fields specified. Default is * or all available fields are returned. Can be left blank or not included.

Available fields list

*, supplier_name, source_name, source_url, licence_name, licence_url, sovereign_state_name, country_name, region_name, area_name, county_name, district_name, supplier_id

Related guide: Selecting fields

Returns

Returns a supplier object if a valid identifier was provided.

ENDPOINTS

GET /suppliers/id/?token=:token&id=:id

REQUEST

GET /suppliers/id/?token=rapidapi-02928-29292-2991AA02-292&id=a86a8ea28d493dc9863cdb4dfe2e9918 HTTP/1.1
X-Rapidapi-Key: {RAPIDAPI-KEY}
X-Rapidapi-Host: government-purchase-orders-api.p.rapidapi.com
Host: government-purchase-orders-api.p.rapidapi.com

RESPONSE

{
  "status": "success",
  "code": 200,
  "message": "OK. Everything worked as expected.",
  "result": {
    "object": "supplier",
    "data": {
      "supplier_name": "RG Carter Southern Ltd",
      "source_name": "West Suffolk Council",
      "source_url": "https://www.westsuffolk.gov.uk/",
      "licence_name": "Open Government Licence (OGL)",
      "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
      "sovereign_state_name": "United Kingdom",
      "country_name": "England",
      "region_name": "East of England",
      "area_name": "East Anglia",
      "county_name": "Suffolk",
      "district_name": "West Suffolk District",
      "supplier_id": "a86a8ea28d493dc9863cdb4dfe2e9918"
    },
    "query": {
      "fields": "*",
      "filters": {
        "supplier_name": "RG Carter Southern Ltd"
      },
      "limit": 1,
      "offset": 1,
      "dataset": "government_purchase_orders",
      "order_by": "supplier_name",
      "group_by": "supplier_name"
    }
  }
}
Go to top

4.d. Get Supplier By Name

Retrieves the supplier object with the given name.

Test Endpoint

Authorisation

Requires Rapidapi Key for api authorisation.

Related guide: Authentication

Parameters

name string required

Unique name for the object in string format.

fields string optional (can be left blank)

Only return the Supplier with the list of fields specified. Default is * or all available fields are returned. Can be left blank or not included.

Available fields list

*, supplier_name, source_name, source_url, licence_name, licence_url, sovereign_state_name, country_name, region_name, area_name, county_name, district_name, supplier_id

Related guide: Selecting fields

Returns

Returns a supplier object if a valid identifier was provided.

ENDPOINTS

GET /suppliers/name/?token=:token&name=:name

REQUEST

GET /suppliers/name/?token=rapidapi-02928-29292-2991AA02-292&name=RG%20Carter%20Southern%20Ltd HTTP/1.1
X-Rapidapi-Key: 5295a77d32mshf46fa7a2fefd164p1e54f0jsnefc6eb2e1853
X-Rapidapi-Host: government-purchase-orders-api.p.rapidapi.com
Host: government-purchase-orders-api.p.rapidapi.com

RESPONSE

{
  "status": "success",
  "code": 200,
  "message": "OK. Everything worked as expected.",
  "result": {
    "object": "supplier",
    "data": {
      "supplier_name": "RG Carter Southern Ltd",
      "source_name": "West Suffolk Council",
      "source_url": "https://www.westsuffolk.gov.uk/",
      "licence_name": "Open Government Licence (OGL)",
      "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
      "sovereign_state_name": "United Kingdom",
      "country_name": "England",
      "region_name": "East of England",
      "area_name": "East Anglia",
      "county_name": "Suffolk",
      "district_name": "West Suffolk District",
      "supplier_id": "a86a8ea28d493dc9863cdb4dfe2e9918"
    },
    "query": {
      "fields": "*",
      "filters": {
        "supplier_name": "RG Carter Southern Ltd"
      },
      "limit": 1,
      "offset": 1,
      "dataset": "government_purchase_orders",
      "order_by": "supplier_name",
      "group_by": "supplier_name"
    }
  }
}
Go to top

4.e. List Suppliers

Returns a list of suppliers.

Test Endpoint

Authorisation

Requires Rapidapi Key for api authorisation.

Related guide: Authentication

Parameters

fields string optional (can be left blank)

Only return the Suppliers with the list of fields specified. By default * or all available fields are returned. Can be left blank or not included.

Related guide: Selecting fields

Available fields list

*, supplier_name, source_name, source_url, licence_name, licence_url, sovereign_state_name, country_name, region_name, area_name, county_name, district_name, supplier_id

order_by string optional (can be left blank)

Return the Suppliers with the ordering specified. Can be left blank or not included.

Related guide: Ordering rows

Available fields list

supplier_id, supplier_id asc, supplier_id desc,supplier_name, supplier_name asc, supplier_name desc, sovereign_state_name, sovereign_state_name asc, sovereign_state_name desc, country_name, country_name asc, country_name desc, region_name, region_name asc, region_name desc, area_name, area_name asc, area_name desc, county_name, county_name asc, county_name desc, district_name, district_name asc, district_name desc

group_by string optional (can be left blank)

Groups the Suppliers with the grouping specified. Can be left blank or not included.

Related guide: Grouping rows

Available fields list

supplier_name, sovereign_state_name, country_name, county_name, region_name, area_name, district_name, supplier_id

supplier_name string optional (can be left blank)

Only return the Suppliers for the name specified. Can be left blank or not included.

sovereign_state_name string optional (can be left blank)

Only return the Suppliers for the sovereign state name specified. Can be left blank or not included.

country_name string optional (can be left blank)

Only return the Suppliers for the country name specified. Can be left blank or not included.

county_name string optional (can be left blank)

Only return the Suppliers for the county name specified. Can be left blank or not included.

region_name string optional (can be left blank)

Only return the Suppliers for the region name specified. Can be left blank or not included.

area_name string

Only return the Suppliers for the area name specified. Can be left blank or not included.

district_name string optional (can be left blank)

Only return the Suppliers for the district name specified. Can be left blank or not included.

organisation_id string optional (can be left blank)

Only return the Organisations for the organisation id specified. Can be left blank or not included.

organisation_name string optional (can be left blank)

Only return the Organisations for the organisation name specified. Can be left blank or not included.

supplier_id string optional (can be left blank)

Only return the Organisations for the supplier id specified. Can be left blank or not included.

Returns

A dictionary with a data property that contains an array of up to limit organisations, starting after page. Each entry in the data array is a separate organisation object. If no more organisations are available, the resulting array will be empty.

ENDPOINTS

GET /suppliers/list/?token=:token

REQUEST

GET /suppliers/list/?token=rapidapi-02928-29292-2991AA02-292 HTTP/1.1
X-Rapidapi-Key: {RAPIDAPI-KEY}
X-Rapidapi-Host: government-purchase-orders-api.p.rapidapi.com
Host: government-purchase-orders-api.p.rapidapi.com

RESPONSE

{
  "status": "success",
  "code": 200,
  "message": "OK. Everything worked as expected.",
  "result": {
    "object": "list",
    "data": [
      {
        "supplier_name": "Getmapping PLC",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "supplier_id": "03f7da06ed2ebe92286dece9df9f70c0"
      },
      {
        "supplier_name": "Silverbird Ltd.",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "supplier_id": "0512ea844da6007884a9e34b7685bed6"
      },
      {
        "supplier_name": "VP-AV Ltd",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "supplier_id": "06419dfcf7936ae7282bc34ed01ecb3a"
      },
      {
        "supplier_name": "Novus Property Solutions Ltd",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "supplier_id": "06e9f5a2d43a42ce7f5ee23287459563"
      },
      {
        "supplier_name": "National Gilbert & Sullivan Opera Company Ltd",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "supplier_id": "097668fd7e3b7b9a3c1d3c17a965ed81"
      },
      {
        "supplier_name": "Palmer Fencing Ltd",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "supplier_id": "09ddbd0b42e1e9f0e336053f67c9572a"
      },
      {
        "supplier_name": "United Stage International Limited",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "supplier_id": "0b6efc158a700a107b01ca2ed68121d0"
      },
      {
        "supplier_name": "East Suffolk Council",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "supplier_id": "0c3fc92a1a7b8ec32ff84a8a7347236c"
      },
      {
        "supplier_name": "CBRE Ltd",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "supplier_id": "0cf6225e22b1c38f5fb696e07e38da59"
      },
      {
        "supplier_name": "INOVEM Limited t/a KAHOOTZ",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "supplier_id": "10793456caf6ab6212127794a7b7ff82"
      }
    ],
    "pagination": {
      "total_records": 188,
      "current_page": 1,
      "next_page": 2,
      "previous_page": false,
      "records_per_page": "10",
      "total_pages": 19
    },
    "query": {
      "fields": "*, supplier_id",
      "filters": [],
      "limit": "10",
      "offset": 0,
      "dataset": "government_purchase_orders",
      "order_by": "supplier_id",
      "group_by": "supplier_id"
    }
  }
}
Go to top

4.f. Search Suppliers

Returns a list of suppliers given a search query string.

Test Endpoint

Authorisation

Requires Rapidapi Key for api authorisation.

Related guide: Authentication

Parameters

query string required

The search query string.

fields string optional (can be left blank)

Only return the Suppliers with the list of fields specified. By default * or all available fields are returned. Can be left blank or not included.

Related guide: Selecting fields

Available fields list

*, supplier_name, source_name, source_url, licence_name, licence_url, sovereign_state_name, country_name, region_name, area_name, county_name, district_name, supplier_id

order_by string optional (can be left blank)

Return the Suppliers with the ordering specified. Can be left blank or not included.

Related guide: Ordering rows

Available fields list

supplier_id, supplier_id asc, supplier_id desc,supplier_name, supplier_name asc, supplier_name desc, sovereign_state_name, sovereign_state_name asc, sovereign_state_name desc, country_name, country_name asc, country_name desc, region_name, region_name asc, region_name desc, area_name, area_name asc, area_name desc, county_name, county_name asc, county_name desc, district_name, district_name asc, district_name desc

group_by string optional (can be left blank)

Groups the Suppliers with the grouping specified. Can be left blank or not included.

Related guide: Grouping rows

Available fields list

supplier_name, sovereign_state_name, country_name, county_name, region_name, area_name, district_name, supplier_id

supplier_name string optional (can be left blank)

Only return the Suppliers for the name specified. Can be left blank or not included.

sovereign_state_name string optional (can be left blank)

Only return the Suppliers for the sovereign state name specified. Can be left blank or not included.

country_name string optional (can be left blank)

Only return the Suppliers for the country name specified. Can be left blank or not included.

county_name string optional (can be left blank)

Only return the Suppliers for the county name specified. Can be left blank or not included.

region_name string optional (can be left blank)

Only return the Suppliers for the region name specified. Can be left blank or not included.

area_name string

Only return the Suppliers for the area name specified. Can be left blank or not included.

district_name string optional (can be left blank)

Only return the Suppliers for the district name specified. Can be left blank or not included.

organisation_id string optional (can be left blank)

Only return the Organisations for the organisation id specified. Can be left blank or not included.

organisation_name string optional (can be left blank)

Only return the Organisations for the organisation name specified. Can be left blank or not included.

supplier_id string optional (can be left blank)

Only return the Organisations for the supplier id specified. Can be left blank or not included.

Returns

A dictionary with a data property that contains an array of up to limit organisations, starting after page. Each entry in the data array is a separate organisation object. If no more organisations are available, the resulting array will be empty.

ENDPOINTS

GET /suppliers/search/?token=:token&query=:query

REQUEST

GET /suppliers/search/?token=rapidapi-02928-29292-2991AA02-292&query=music HTTP/1.1
X-Rapidapi-Key: {RAPIDAPI-KEY}
X-Rapidapi-Host: government-purchase-orders-api.p.rapidapi.com
Host: government-purchase-orders-api.p.rapidapi.com

RESPONSE

{
  "status": "success",
  "code": 200,
  "message": "OK. Everything worked as expected.",
  "result": {
    "object": "search_result",
    "data": [
      {
        "supplier_name": "1974 Music Ltd",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "supplier_id": "5af13a0d655a021167e4c00c26fe2ec1"
      },
      {
        "supplier_name": "Academy of Ancient Music",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "supplier_id": "65f46d6abfc1f1d16c120648d2afe262"
      },
      {
        "supplier_name": "Cole Music Productions UK T/A CMP Entertainment",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "supplier_id": "f2f9d085651c5cd5eb00562d3379a349"
      },
      {
        "supplier_name": "Craven Songs and Music Ltd",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "supplier_id": "e0a52e58d422145d91fe27dbe73c2546"
      },
      {
        "supplier_name": "DFO International Music Agency",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "supplier_id": "305733d6d51b0d0fbcb54652a7a6ffbf"
      },
      {
        "supplier_name": "RLN Music Ltd",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "supplier_id": "eab7afd557b030a00c931379b66db961"
      },
      {
        "supplier_name": "Showdown Music Ltd",
        "source_name": "West Suffolk Council",
        "source_url": "https://www.westsuffolk.gov.uk/",
        "licence_name": "Open Government Licence (OGL)",
        "licence_url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "sovereign_state_name": "United Kingdom",
        "country_name": "England",
        "region_name": "East of England",
        "area_name": "East Anglia",
        "county_name": "Suffolk",
        "district_name": "West Suffolk District",
        "supplier_id": "5641d7ab643560bfbe604781e3b0ca07"
      }
    ],
    "pagination": {
      "total_records": 7,
      "current_page": 1,
      "next_page": false,
      "previous_page": false,
      "records_per_page": "10",
      "total_pages": 1
    },
    "query": {
      "fields": "*, supplier_id",
      "query": "music",
      "filters": [],
      "limit": "10",
      "offset": 0,
      "dataset": "government_purchase_orders",
      "order_by": "supplier_name",
      "group_by": "supplier_id",
      "query_filters": [
        "supplier_name",
        "sovereign_state_name",
        "country_name",
        "region_name",
        "area_name",
        "county_name",
        "district_name",
        "supplier_id",
        "organisation_id",
        "organisation_name"
      ]
    }
  }
}
Go to top

About

Products

Resources

Government Purchase Orders Docs

Solutions

Copyright © 2025 ODAPIS.com Manage Cookies Privacy & Cookies Website Disclaimer

This website is using cookies to help you give the best experience we can. By clicking 'Accept', you agree that this site using cookies. If you do not want cookies to be used, you can click the "Decline" button, but it may have an impact on the way you experience our website.

Accept Decline