Skip to main content

ResourceAvailability

A persisted resource availability row. start and end are UTC instants from startDate+startTime and endDate (or startDate when null)+endTime; see createAvailability.

type ResourceAvailability {
  id: ID!
  comment: String!
  unavailability: Boolean!
  unavailabilityType: UnavailabilityType
  resourceType: AvailabilityResourceType!
  user: User
  room: PracticeLocation!
  recurrence: AvailabilityRecurrence
  exclusions: [String!]!
  startDate: String!
  endDate: String
  startTime: String!
  endTime: String!
  createdAt: DateTime!
  updatedAt: DateTime!
  createdBy: ID!
  lastUpdatedBy: ID!
}

Fields​

ResourceAvailability.id ● ID! non-null scalar​

ResourceAvailability.comment ● String! non-null scalar​

ResourceAvailability.unavailability ● Boolean! non-null scalar​

ResourceAvailability.unavailabilityType ● UnavailabilityType enum​

Reason for blocked time.

Set on every unavailability. Null on availability rows.

ResourceAvailability.resourceType ● AvailabilityResourceType! non-null enum​

Persisted as lowercase (user).

ResourceAvailability.user ● User object​

ResourceAvailability.room ● PracticeLocation! non-null object​

The room for this rule. Uses PracticeLocation.id (room ID)

ResourceAvailability.recurrence ● AvailabilityRecurrence object​

ResourceAvailability.exclusions ● [String!]! non-null scalar​

Dates on which this recurring availability does not apply.

On create/update input, send plain YYYY-MM-DD dates. Returned values are ISO 8601 UTC instants (for example, ["2026-01-01T00:00:00.000Z", "2026-12-25T00:00:00.000Z"]).

Updates append rather than replace.

ResourceAvailability.startDate ● String! non-null scalar​

Start date in YYYY-MM-DD format.

ResourceAvailability.endDate ● String scalar​

End date in YYYY-MM-DD format, if any.

ResourceAvailability.startTime ● String! non-null scalar​

Start time in HH:mm format.

ResourceAvailability.endTime ● String! non-null scalar​

End time in HH:mm format.

ResourceAvailability.createdAt ● DateTime! non-null scalar​

ResourceAvailability.updatedAt ● DateTime! non-null scalar​

ResourceAvailability.createdBy ● ID! non-null scalar​

Author of the row. For Settings API credentials this may be the credential ID rather than a user ID.

ResourceAvailability.lastUpdatedBy ● ID! non-null scalar​

Last editor of the row. For Settings API credentials this may be the credential ID rather than a user ID.

Member Of​

AvailabilityRulesData object ● ResourceAvailabilityCreatePayload object ● ResourceAvailabilityDeletePayload object ● ResourceAvailabilityQueryPayload object ● ResourceAvailabilityRuleQueryPayload object ● ResourceAvailabilityUpdatePayload object