Look Up UK Outcode

Returns the area, districts and coordinates for the first half of a postcode.

Unverified

What the model is told

Look up an outcode, which is the first half of a UK postcode such as SW1A or M1. Returns the districts, country and coordinates it covers. Use it when the customer only gives the first part of their postcode.

Request

GEThttps://api.postcodes.io/outcodes/{{outcode}}

Headers

None.

Parameters

outcode stringThe first half of a UK postcode in capitals with no spaces, for example SW1A.

Try this tool

This runs in your browser and calls Postcodes.io directly. Nothing goes through our servers.

Engage payload

{
  "source": "VOICE_AI",
  "tool": {
    "id": "e326b6e1-fa13-46ed-bdd4-9e2d99aead58",
    "type": "HTTP_REQUEST",
    "label": "Look Up UK Outcode",
    "name": "look_up_uk_outcode",
    "customName": false,
    "description": "Look up an outcode, which is the first half of a UK postcode such as SW1A or M1. Returns the districts, country and coordinates it covers. Use it when the customer only gives the first part of their postcode.",
    "parameters": [
      {
        "name": "outcode",
        "type": "string",
        "description": "The first half of a UK postcode in capitals with no spaces, for example SW1A."
      }
    ],
    "config": {
      "endpoint": {
        "method": "GET",
        "url": "https://api.postcodes.io/outcodes/{{outcode}}"
      },
      "headers": [],
      "body": null,
      "timeout": null
    }
  }
}

IDs are regenerated on every copy.