---
title: entities.appointmentReminder
description: Read appointment reminder records with the appointmentReminder repository, and change them with the appointment reminder mutations. Same records as the REST AppointmentReminders entity.
canonical: https://developers.coevera.com/reference/graphql/appointment-reminder/
section: graphql
verification: schema
generatedFrom: schema f155746 (2026-10-20)
publisher: Coevera
---

# entities.appointmentReminder

Read appointment reminder records with the appointmentReminder repository, and change them with the appointment reminder mutations. Same records as the REST AppointmentReminders entity.

REST: [AppointmentReminders](https://developers.coevera.com/reference/rest/appointment-reminders.md).

## Queries

- `getById(entityId: ID!): AppointmentReminderEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well.
- `getByIds(entityIds: [ID!]!): [AppointmentReminderEntity!]!` Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
- `getAll(limit: Int, offset: Int, filter: AppointmentReminderFilterInput, orderBy: [AppointmentReminderOrderByInput!], includeDeleted: Boolean): [AppointmentReminderEntity!]!` Returns the records that match the filter, paged with limit and offset.
- `getByCriteria(filter: AppointmentReminderFilterInput, orderBy: [AppointmentReminderOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): AppointmentReminderEntityConnection` Returns the records that match the filter as a cursor-paginated connection.
- `getChangedFieldsSinceRevision(id: UUID!, revision: Int!): [UUID!]!` Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.

## Mutations

- `createAppointmentReminder(input: CreateAppointmentReminderInput!, validationLevel: [ValidationLevel!]): CreateAppointmentReminderPayload` Create one record.
- `updateAppointmentReminder(input: UpdateAppointmentReminderInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateAppointmentReminderPayload` Update fields.
- `bulkUpdateAppointmentReminder(input: [CreateOrUpdateAppointmentReminderInput!]!, deleteInput: [DeleteAppointmentReminderInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateAppointmentReminderPayload` Create or update many; per-item results.
- `deleteAppointmentReminder(input: DeleteAppointmentReminderInput!): DeleteAppointmentReminderPayload` Soft-delete.

## Types

### AppointmentReminderEntity (object)

Reminder a user has set for an appointment, notifying them a given time before it starts.

- `isDeleteProtected: Boolean!` True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
- `id: ID!` Unique identifier of entity.
- `isDeleted: Boolean` Specifies if the entity is considered deleted.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `appointment: AppointmentEntity` Appointment this reminder belongs to.
- `owner: ClientEntity` User who set this reminder. Reminders are per-user.
- `appointmentId: ID!` Id of the appointment this reminder belongs to.
- `endDateOffset: Int!` Seconds before the appointment start when the reminder should fire.
- `ownerId: ID!` Id of the user who set the reminder.
- `snoozeDate: DateTime` Timestamp when a snoozed reminder should fire again. Empty when not snoozed.
- `status: ReminderStatusEnum` Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed.
- `revision: Int` Revision when entity was lastly changed.
- `instancePermissions: [EntityPermsEnum!]! (1 args)` Permissions the current user has on this record, out of the requested ones.

### AppointmentReminderEntityConnection (object)

Paginated list of AppointmentReminder records.

- `pageInfo: PageInfo!` Pagination data for this connection.
- `edges: [AppointmentReminderEntityEdge]!` Contains the nodes in this connection.
- `totalCount: Int` Total number of items in the connection.

### AppointmentReminderEntityEdge (object)

A Relay edge containing a `AppointmentReminderEntity` and its cursor.

- `node: AppointmentReminderEntity` The item at the end of the edge
- `cursor: String!` A cursor for use in pagination

### AppointmentReminderFilterInput (input)

Filter conditions for AppointmentReminder records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

- `OR: [AppointmentReminderFilterInput!]` Matches records that meet at least one of the listed filters.
- `AND: [AppointmentReminderFilterInput!]` Matches records that meet all of the listed filters.
- `NOT: AppointmentReminderFilterInput` Matches records that do not meet this filter.
- `globalSearchQuery: String` Search term matched against the fields that the global search covers for this entity.
- `id: EntityFilterStringField` Unique identifier of entity.
- `isDeleted: Boolean` Specifies if the entity is considered deleted.
- `modified: EntityFilterDateTimeField` Last modification time.
- `created: EntityFilterDateTimeField` Creation time.
- `appointmentId: EntityFilterStringField` Id of the appointment this reminder belongs to.
- `endDateOffset: EntityFilterNumberField` Seconds before the appointment start when the reminder should fire.
- `ownerId: EntityFilterStringField` Id of the user who set the reminder.
- `snoozeDate: EntityFilterDateTimeField` Timestamp when a snoozed reminder should fire again. Empty when not snoozed.
- `status: ReminderStatusEnumFilterInput` Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed.
- `revision: EntityFilterNumberField` Revision when entity was lastly changed.
- `appointment: AppointmentFilterInput` Appointment this reminder belongs to. Matches records where a related record meets these conditions.
- `owner: ClientFilterInput` User who set this reminder. Reminders are per-user. Matches records where a related record meets these conditions.

### AppointmentReminderOrderByInput (input)

Sorting of AppointmentReminder records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

- `id: OrderByEnum` Unique identifier of entity.
- `isDeleted: OrderByEnum` Specifies if the entity is considered deleted.
- `modified: OrderByEnum` Last modification time.
- `created: OrderByEnum` Creation time.
- `appointment: [AppointmentOrderByNestedInput!]` Appointment this reminder belongs to. Sorts by fields of the related record, listed in order of priority.
- `owner: [ClientOrderByNestedInput!]` User who set this reminder. Reminders are per-user. Sorts by fields of the related record, listed in order of priority.
- `appointmentId: OrderByEnum` Id of the appointment this reminder belongs to.
- `endDateOffset: OrderByEnum` Seconds before the appointment start when the reminder should fire.
- `ownerId: OrderByEnum` Id of the user who set the reminder.
- `snoozeDate: OrderByEnum` Timestamp when a snoozed reminder should fire again. Empty when not snoozed.
- `status: OrderByEnum` Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed.
- `revision: OrderByEnum` Revision when entity was lastly changed.

### CreateAppointmentReminderInput (input)

Field values of a new AppointmentReminder record.

- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `appointmentId: ID!` Id of the appointment this reminder belongs to.
- `endDateOffset: Int!` Seconds before the appointment start when the reminder should fire.
- `ownerId: ID!` Id of the user who set the reminder.
- `snoozeDate: DateTime` Timestamp when a snoozed reminder should fire again. Empty when not snoozed.
- `status: ReminderStatusEnum` Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed.
- `revision: Int` Revision when entity was lastly changed.

### CreateOrUpdateAppointmentReminderInput (input)

Field values of an AppointmentReminder record to create, or to update when its id is set.

- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
- `id: ID` Unique identifier of entity.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `appointmentId: ID` Id of the appointment this reminder belongs to.
- `endDateOffset: Int` Seconds before the appointment start when the reminder should fire.
- `ownerId: ID` Id of the user who set the reminder.
- `snoozeDate: DateTime` Timestamp when a snoozed reminder should fire again. Empty when not snoozed.
- `status: ReminderStatusEnum` Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed.
- `revision: Int` Revision when entity was lastly changed.

### DeleteAppointmentReminderInput (input)

Id of the AppointmentReminder record to delete.

- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
- `id: ID!` Unique identifier of entity.

### UpdateAppointmentReminderInput (input)

Id of an AppointmentReminder record and the field values to change.

- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
- `id: ID!` Unique identifier of entity.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `appointmentId: ID` Id of the appointment this reminder belongs to.
- `endDateOffset: Int` Seconds before the appointment start when the reminder should fire.
- `ownerId: ID` Id of the user who set the reminder.
- `snoozeDate: DateTime` Timestamp when a snoozed reminder should fire again. Empty when not snoozed.
- `status: ReminderStatusEnum` Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed.
- `revision: Int` Revision when entity was lastly changed.

### BulkUpdateAppointmentReminderPayload (object)

Result of the bulkUpdateAppointmentReminder mutation.

- `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed.

### CreateAppointmentReminderPayload (object)

Result of the createAppointmentReminder mutation.

- `appointmentReminder: AppointmentReminderEntity` The created record.
- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

### DeleteAppointmentReminderPayload (object)

Result of the deleteAppointmentReminder mutation.

- `appointmentReminder: AppointmentReminderEntity` The deleted record.
- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

### UpdateAppointmentReminderPayload (object)

Result of the updateAppointmentReminder mutation.

- `appointmentReminder: AppointmentReminderEntity` The updated record.
- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

Types several repositories share, such as `PageInfo` and the filter fields, are in the [types index](https://developers.coevera.com/reference/graphql/types.md). The [SDL](https://developers.coevera.com/graphql/schema.graphql) has the whole schema in one file.

## Example

```graphql
query FirstAppointmentReminders {
  entities {
    appointmentReminder {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}
```

```bash
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstAppointmentReminders { entities { appointmentReminder { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'
```