Groups

List groups

Returns a list of all groups accessible to the authenticated user, ordered by name.
Groups are collections of people that can be assigned to roles for access control.
Groups can be static (manually assigned) or dynamic (based on LDAP/directory queries).
This endpoint does not support pagination.

GET /api/3/groups

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.group.readonly

Responses

200

List of groups retrieved successfully

Response Fields

id integer required

Unique identifier for the group

eg. 15
name string required

Name of the group (must be present)

eg. Marketing Team
notes string | null

Additional notes about this group

eg. Access to marketing floor and conference rooms
global_across_sites boolean required

Whether this group applies across all sites in multi-site deployments

created_at string required

Timestamp of creation

updated_at string required

Timestamp of last update

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

Mentioned in Guides

This endpoint is used in the following guides:

Core Resources Reference

Quick reference for People, Credentials, Channels, Groups, and Roles

Core Concepts • 5 min • Beginner

Employee Onboarding Workflow

Complete code to onboard new employees with card and PIN in 7 minutes

Common Workflows • 7 min • Intermediate

Request

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

Responses

List of groups retrieved successfully

[
  {
    "id": 15,
    "name": "Marketing Team",
    "notes": "Access to marketing floor and conference rooms",
    "global_across_sites": false,
    "created_at": "string",
    "updated_at": "string"
  }
]