---
updatedAt: 2026-05-27T10:18:53.000Z
agentTools:
  projectIndex: https://gethapn.readme.io/llms.txt
---

# Get list of boundaries

Returns a list of all boundaries in the account.

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "description": "The Hapn API is an HTTP interface for managing devices, accounts, and cloud data.",
    "version": "1.0.0",
    "title": "Hapn API",
    "termsOfService": "https://gethapn.com/terms",
    "contact": {
      "name": "Dev",
      "email": "developer@gethapn.com",
      "url": "http://gethapn.com"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    }
  },
  "servers": [
    {
      "url": "https://api.iotgps.io/v1",
      "description": "Prod"
    },
    {
      "url": "https://api-dev.iotgps.io/v1",
      "description": "Dev"
    }
  ],
  "paths": {
    "/boundaries": {
      "get": {
        "summary": "Get list of boundaries",
        "tags": [
          "Boundaries"
        ],
        "responses": {
          "200": {
            "description": "Boundary list result",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/PaginatedSuccessResponse"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "result": {
                          "type": "object",
                          "required": [
                            "items"
                          ],
                          "properties": {
                            "items": {
                              "type": "array",
                              "uniqueItems": true,
                              "minItems": 1,
                              "items": {
                                "$ref": "#/components/schemas/Boundary"
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                },
                "examples": {
                  "example-1": {
                    "value": {
                      "success": true,
                      "message": "ok",
                      "result": {
                        "items": [
                          {
                            "boundaryId": 316385,
                            "name": "Turner Towers",
                            "created": "2021-04-23T12:57:14.000Z",
                            "modified": "2021-04-23T12:57:14.000Z",
                            "location": "115 Eastern Parkway, Brooklyn, New York 11238, United States",
                            "color": "#9b59b6",
                            "status": "active",
                            "geometry": {
                              "id": "033c88d812c21bbaabaa5f650e267156",
                              "type": "Feature",
                              "properties": {},
                              "geometry": {
                                "coordinates": [
                                  [
                                    [
                                      -73.96689197286175,
                                      40.67429897688385
                                    ],
                                    [
                                      -73.96285891553887,
                                      40.67351038085229
                                    ],
                                    [
                                      -73.96255958706571,
                                      40.67145520797439
                                    ],
                                    [
                                      -73.96747487567782,
                                      40.67269787821573
                                    ],
                                    [
                                      -73.96689197286175,
                                      40.67429897688385
                                    ]
                                  ]
                                ],
                                "type": "Polygon"
                              }
                            }
                          },
                          {
                            "boundaryId": 389770,
                            "name": "High Priority ADA Lot ",
                            "created": "2022-05-24T16:32:17.595Z",
                            "modified": "2022-05-24T16:32:17.595Z",
                            "location": "49R7+W6 Austin, TX, USA",
                            "color": "#3498db",
                            "status": "deleted",
                            "geometry": {
                              "type": "Feature",
                              "geometry": {
                                "type": "Polygon",
                                "coordinates": [
                                  [
                                    [
                                      -97.63711101802231,
                                      30.14158446170009
                                    ],
                                    [
                                      -97.63564116748215,
                                      30.14270711268957
                                    ],
                                    [
                                      -97.63585574420334,
                                      30.142818449281595
                                    ],
                                    [
                                      -97.63629562648178,
                                      30.142623610163103
                                    ],
                                    [
                                      -97.63674623759628,
                                      30.143041122088743
                                    ],
                                    [
                                      -97.63766891749741,
                                      30.14239165832993
                                    ],
                                    [
                                      -97.63818390162827,
                                      30.142094759187838
                                    ]
                                  ]
                                ]
                              },
                              "properties": {}
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "get-boundaries",
        "description": "Returns a list of all boundaries in the account."
      }
    }
  },
  "components": {
    "schemas": {
      "Boundary": {
        "type": "object",
        "x-examples": {
          "example-1": {
            "boundaryId": 316385,
            "name": "Turner Towers",
            "created": "2021-04-23T12:57:14.000Z",
            "modified": "2021-04-23T12:57:14.000Z",
            "location": "115 Eastern Parkway, Brooklyn, New York 11238, United States",
            "color": "#9b59b6",
            "status": "active",
            "geometry": {
              "id": "033c88d812c21bbaabaa5f650e267156",
              "type": "Feature",
              "properties": {},
              "geometry": {
                "coordinates": [
                  [
                    [
                      -73.96689197286175,
                      40.67429897688385
                    ],
                    [
                      -73.96285891553887,
                      40.67351038085229
                    ],
                    [
                      -73.96255958706571,
                      40.67145520797439
                    ],
                    [
                      -73.96747487567782,
                      40.67269787821573
                    ],
                    [
                      -73.96689197286175,
                      40.67429897688385
                    ]
                  ]
                ],
                "type": "Polygon"
              }
            }
          }
        },
        "description": "",
        "properties": {
          "boundaryId": {
            "type": "integer"
          },
          "color": {
            "description": "Hex color code `#RRGGBB`",
            "type": "string"
          },
          "created": {
            "type": "string"
          },
          "geometry": {
            "description": "Polygon definition on GeoJSON format. For more info see: https://datatracker.ietf.org/doc/html/rfc7946",
            "type": "object"
          },
          "location": {
            "description": "Address",
            "type": "string"
          },
          "modified": {
            "type": "string"
          },
          "name": {
            "description": "Boundary name",
            "type": "string"
          },
          "status": {
            "description": "Boundary status",
            "enum": [
              "active",
              "deleted"
            ]
          }
        }
      },
      "PaginatedSuccessResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "message": {
            "type": "string"
          },
          "result": {
            "type": "object",
            "properties": {
              "items": {
                "type": "array"
              },
              "nextToken": {
                "type": "string"
              }
            },
            "required": [
              "items"
            ]
          }
        },
        "required": [
          "message",
          "success",
          "result"
        ],
        "x-examples": {
          "example-1": {
            "value": {
              "success": true,
              "message": "string",
              "result": {
                "items": [
                  {
                    "imei": "12345"
                  }
                ],
                "nextToken": "eyJzZW5kVGltZSI6IjIwMjEtMDgtMThUMTU6MTc6NTAuMDAwWiIsImNsaWVudElkIjo2MDY2MDksIm1lc3NhZ2VfaWQiOiI2ZTMwYzczMS1iMGNhLTQwMzgtYjY1Zi1kM2Y1NGZlMWQ0ZjUifQ=="
              }
            }
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "message": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "message"
        ],
        "x-examples": {
          "example-1": {
            "value": {
              "success": false,
              "message": "Unauthorized"
            }
          }
        }
      }
    },
    "responses": {
      "Unauthorized": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "example-1": {
                "value": {
                  "success": false,
                  "message": "Unauthorized"
                }
              }
            }
          }
        }
      },
      "Error": {
        "description": "Server error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "example-1": {
                "value": {
                  "success": false,
                  "message": "Error"
                }
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "OAuth2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://auth.usehapn.com/oauth2/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "tags": [
    {
      "name": "Boundaries",
      "description": "User's boundaries"
    }
  ],
  "security": [
    {
      "OAuth2": []
    }
  ]
}
```