Get Edges

Retrieve the list of Edges (proxies) for your organization.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Returns the list of Edges configured for your organization. An Edge represents a proxy through which devices on a local network can be reached.

Authorization

This endpoint requires Authorization.

Query Parameters

KeyTypeDescriptionRequired
pageIntegerPage number (default: 1).No
per_pageIntegerItems per page (default: 100, max: 100).No

Response

Returns Paginated data of the following format for each item:

KeySubkeyTypeDescription
idStringUnique identifier for the Edge.
display_nameStringHuman-readable display name of the Edge.
statusStringCurrent status of the Edge: online / offline.
customerObjectCustomer space this Edge is tied to.
idStringIdentifier of the customer space.
nameStringName of the customer space.
last_sync_atDatetimeTimestamp of the last successful sync (nullable).
created_atDatetimeCreation timestamp.
updated_atDatetimeLast update timestamp.
{
  "items": [
    {
      "id": "5e7b1f0a-3c2d-4e5f-9a8b-1c2d3e4f5a6b",
      "display_name": "HQ Edge",
      "status": "online",
      "customer": {
        "id": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
        "name": "Acme HQ"
      },
      "last_sync_at": "2026-05-14T09:00:00Z",
      "created_at": "2026-05-01T12:00:00Z",
      "updated_at": "2026-05-14T09:00:00Z"
    }
  ],
  "next_page": null
}

Errors

StatusDescription
401Missing or invalid Authorization header.
Query Params
integer
Defaults to 1

Page number, starting at 1.

integer
Defaults to 100

Number of results per page. Min: 1, Max: 100.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json