List the descendants of an administrative division, at any depth
Returns every division below the given one, across intermediate levels, optionally filtered by type and bounded by maxDepth. maxDepth of 1 returns only the direct children. Use this to list, for example, every neighborhood of a city — including Paris, Lyon and Marseille, whose neighborhoods sit under an arrondissement. Set includeSelf=true to also return the division itself (its full scope: the division and everything below).
Authorization
apiKey Value for the X-API-KEY header parameter.
In: header
Path Parameters
Ancestor administrative division id.
Query Parameters
Filter the descendants by type. Supports a single value (?locationType=NEIGHBORHOOD) or array syntax (?locationType[]=MUNICIPAL_DISTRICT&locationType[]=NEIGHBORHOOD).
Limit how many levels below the division to include. 1 returns only the direct children; omit for any depth.
1 <= valueInclude the division itself alongside its descendants. The division is always included when set, regardless of type or maxDepth. Defaults to false.
Number of items per page, from 1 to 100. A value outside that range is brought back to the nearest bound.
1 <= value <= 10030The collection page number
1Response Body
curl -X GET "https://example.com/geo/administrative-divisions/3fa85f64-5717-4562-b3fc-2c963f66afa6/descendants?locationType=NEIGHBORHOOD&maxDepth=1&includeSelf=false&size=30"[ { "name": "Paris", "uniqueCode": "75056", "locationType": "MUNICIPALITY", "countryCode": "FR", "postalCodes": [ "75001", "75002", "75003" ], "centroid": { "type": "Point", "coordinates": [ 2.3522, 48.8566 ] }, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }]List the ancestors of an administrative division (breadcrumb / drill-up) GET
Returns the parent chain of the given division up to the country root — for example a neighborhood, its arrondissement, commune, department, region and country. By default the division itself is excluded and the chain is ordered root first (country first). Use order=NODE_FIRST for immediate-parent first, and includeSelf=true to prepend the division for a ready-to-render breadcrumb.
Location autocomplete suggestions GET
Returns location suggestions based on search query. Supports typo-tolerant search, postal code prefixes, administrative subregion codes (French department numbers), usual abbreviations, and filtering by administrative type.