Sites

List sites

Returns a paginated list of sites (physical locations) accessible to the authenticated user.
Sites are used to organize channels (door controllers) by physical location and can have
their own time zones and IP address ranges.

GET /api/3/sites

Authentication

This endpoint requires authentication:

OAuth 2.0 Recommended

Use an OAuth 2.0 access token in the Authorization header. This is the recommended authentication method for all integrations. OAuth provides automatic token expiration, granular permission scopes, detailed usage tracking, and per-integration revocation. Learn how to obtain an access token.

Header Format:

Authorization: Bearer YOUR_ACCESS_TOKEN

Required Scopes:

account.site.readonly

Parameters

Query Parameters

per_page integer
Optional

Number of results per page

Default: 500

page integer
Optional

Page number for pagination

Default: 1

skip_pagination boolean
Optional

Skip pagination and return all results

Responses

200

List of sites retrieved successfully

Response Fields

id integer required

Unique identifier for the site

eg. 25
name string required

Name of the site (required)

eg. Main Office
ip_address string | null

Primary IP address for the site (deprecated - use site_ips instead)

eg. 192.168.1.0/24
time_zone string | null

IANA time zone identifier for this site

eg. America/New_York
notes string | null

Additional notes about this site

eg. Corporate headquarters building
site_ips array<object> required

Array of IP address ranges associated with this site

401

Unauthorized - Invalid or missing authentication

Response Fields

error string
eg. unauthorized
error_description string
eg. The access token is invalid
403

Forbidden - User does not have permission

Response Fields

error string
eg. forbidden
error_description string
eg. You are not authorized to access this resource
500

Internal Server Error

Response Fields

error string
eg. internal_server_error
error_description string
eg. An unexpected error occurred

Request

curl -X GET \
  "https://api.doorflow.com/api/3/sites" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Responses

List of sites retrieved successfully

[
  {
    "id": 25,
    "name": "Main Office",
    "ip_address": "192.168.1.0/24",
    "time_zone": "America/New_York",
    "notes": "Corporate headquarters building",
    "site_ips": [
      {
        "ip_address": null
      }
    ]
  }
]