GET
/v1/settlements?q={name}
Settlement Search
Searches settlements (colonias) by partial name. Returns a paginated list with municipality and state context.
Query Parameters
| Param | Type | Description |
|---|---|---|
| q | string | Partial settlement name, min 2 chars. E.g. Polanco |
| page | integer | Page number (20 results per page, default 1) |
Request
curl -H "Authorization: Bearer YOUR_API_KEY" \ "https://api.postalkit.mx/v1/settlements?q=Polanco&page=1"
Response
{
"data": [
{
"id": 8421,
"name": "Polanco I Sección",
"type": "Colonia",
"postal_code": "11510",
"municipality": "Miguel Hidalgo",
"state": "Ciudad de México"
}
],
"links": { "first": "...", "last": "...", "prev": null, "next": "..." },
"meta": { "current_page": 1, "total": 6, "per_page": 20 }
}