Group Reservations

List group reservations

Returns a paginated list of present and future group reservations.
Group reservations temporarily assign people to groups for a specified time period.
Supports incremental sync via since or since_utc parameters.

GET /api/3/group_reservations

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

Parameters

Query Parameters

since string
Optional

Return only group reservations updated since this timestamp (local time)

since_utc string
Optional

Return only group reservations updated since this timestamp (UTC)

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 group reservations retrieved successfully

Response Fields

id integer required

Unique identifier for the group reservation

eg. 456
person_id integer required

ID of the person assigned to the groups

eg. 12345
start_time string required

Start time of the group reservation

eg. 2024-01-15T09:00:00.000Z
end_time string required

End time of the group reservation (must be after start time and in the future)

eg. 2024-01-15T17:00:00.000Z
state string required

Current state of the reservation (pending = not started, active = in progress, deactivated = cancelled or completed)

eg. active
group_ids array<integer> required

Array of group IDs the person is assigned to during this reservation

eg. [1, 3, 5]
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

Request

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

Responses

List of group reservations retrieved successfully

[
  {
    "id": 456,
    "person_id": 12345,
    "start_time": "2024-01-15T09:00:00.000Z",
    "end_time": "2024-01-15T17:00:00.000Z",
    "state": "active",
    "group_ids": [
      0
    ],
    "created_at": "string",
    "updated_at": "string"
  }
]