get
/api/v2/zones/custom/by-sub-type/{id}Python SDK method:
client.custom_zones.get_by_sub_type(job_id)Get custom zones by sub-type results
Returns paginated GeoJSON features for a completed custom zones by sub-type job.
Altitude Help Center — getCustomZonesInput Parameters
| Name | Location | Type | Values | Description | Value Required |
|---|---|---|---|---|---|
id | path | string | - | The id of the job whose results you want to fetch. | Y |
pageToken | query | string | - | Pagination token returned in the Link header of a previous response. Omit to fetch the first page. | N |
Success Responses
200 response: object
Paginated result data. When more pages are available, a Link: rel="next" header and Altitude-* pagination headers are included in the response.
| Name | Type | Description |
|---|---|---|
bbox | array<number (double)> | Bounding box [west, south, east, north]. |
geometry | object | GeoJSON geometry object representing the zone boundary. |
properties | object | Zone metadata object containing the zone's identity, type, display name, and type-specific details. |
type | string | Always "Feature". |
Response Errors
| HTTP Status Code | Reason |
|---|---|
| 400 | The request body or parameters are invalid. |
| 401 | Authentication is required or the provided credentials are invalid. |
| 403 | The authenticated user lacks permission to perform this operation. |
| 404 | The requested resource does not exist. |
| 409 | Result not yet ready. Poll the status monitor. |
| 429 | The request rate limit has been exceeded. |
| 500 | An unexpected server error occurred. |
