List a city’s routes
Every USPS carrier route covering a city, each with its ZIP, route code and how many residential and business addresses it reaches.
Add includePaths=true for the map polygon of each route, or zips= to narrow to particular ZIP codes. Each route's raw object is what Set EDDM routes expects.
Authorization
ClientBearer Client-scoped key as a Bearer JWT; always pinned to your own client.
In: header
Path Parameters
City id (see /client/cities).
Query Parameters
Override the city name (defaults to the DB name).
Comma-separated 5-digit ZIPs. Pages the whole city, then returns only these, with a byZip rollup. Implies all=true.
true to page past 500 to the end of the city (cities can exceed 1,000 routes).
true for whole-city coverage: pages every route and returns byZip, zipCount and totals (savedHomeCount, residentCount, businessCount) WITHOUT nodes. The "how many homes are in this city" read. Implies all=true.
Cursor for manual paging (pageInfo.endCursor).
Rows for ONE page (default 500, ≤500). Ignored with zips/all/summary.
true to include route polygons as [{lng,lat}] paths.
Response Body
application/json
curl -X GET "https://example.com/client/cities/string/carrier-routes"{ "success": true, "data": { "nodes": [ { "zip": "60614", "croute": "C021", "zipName": "CHICAGO", "residentCount": 512, "businessCount": 14, "totalCount": 526, "raw": { "ZIP": "60614", "CROUTE": "C021", "HOME_COUNT": 430, "APT_COUNT": 82, "BUSINESS_C": 14, "TOTAL_COUN": 526 } } ], "totalCount": 1, "summaryExample": { "byZip": [ { "zip": "78704", "zipName": "AUSTIN", "routes": 36, "savedHomeCount": 27292, "residentCount": 24110, "businessCount": 3182 } ], "zipCount": 42, "totals": { "savedHomeCount": 412883, "residentCount": 366401, "businessCount": 46482 }, "cityRouteCount": 523, "complete": true } }}Suggest the best-fit routes GET
Carrier routes around a point, ranked by how well they match the audience you describe rather than purely by distance. Build `targetSelection` from [the attribute catalog](/docs/api-reference/targeting/listdemographicattributes), and give a latitude, longitude and radius to search in. Use this when you care who receives the mail; use [route search](/docs/api-reference/targeting/searchcarrierroutes) when you just want everything nearby.
Audience attribute catalog GET
The audience attributes you can target on: age, gender, income, ethnicity, household size, language, education, home ownership and health insurance. Each attribute lists its options. Mark the ones you want with `selected: true` and pass the result as `targetSelection` to [route suggestions](/docs/api-reference/targeting/suggestcarrierroutes), or as attributes to [the demographics step](/docs/api-reference/campaign-builder/setcampaigndemographics).