Skip to main content
GET
/
api
/
v1
/
towns
{
  "hydra:member": [
    {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "name": "<string>",
      "nameWithCounty": "<string>",
      "county": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "name": "<string>",
        "code": "<string>",
        "state": "<string>"
      },
      "population": 123,
      "latitude": 123,
      "longitude": 123,
      "region": "<string>",
      "country": "https://example.com/"
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "string",
    "type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

Query Parameters

​
page
integer
default:1

The collection page number

​
pagination
boolean

Enable or disable pagination

​
name
string
​
country
string
​
country[]
string[]
​
order[name]
enum<string>
default:asc
Available options:
asc,
desc
​
order[population]
enum<string>
default:asc
Available options:
asc,
desc

Response

Town collection

​
hydra:member
object[]
required
​
hydra:totalItems
integer
Required range: x >= 0
​
hydra:view
object
Example:
{
  "@id": "string",
  "type": "string",
  "hydra:first": "string",
  "hydra:last": "string",
  "hydra:previous": "string",
  "hydra:next": "string"
}
​
hydra:search
object
⌘I