Reminders can be added to Tasks or Calendar Entries. Reminder emails can be sent by a User to themselves, other Users, Clio For Co-Counsel/Clio Connect Contacts, or [any authorized email](https://help.clio.com/hc/en-us/articles/9289861195291-Calendar-Notifications-and-Reminders). An in-Clio pop-up reminder can also be sent by a User to themself. [Support Link](https://help.clio.com/hc/en-us/articles/9289861195291-Calendar-Notifications-and-Reminders)
openapi: 3.0.0
info:
title: Clio API Documentation Activities Reminders API
contact:
name: Clio API Support
email: api@clio.com
description: "# Developer Support and Feedback\n* Clio takes the availability and stability of our API seriously; please report any **degradations** or **breakages** to Clio's API Support team at [api@clio.com](mailto:api@clio.com).\n* For business and partnership inquiries, contact our API Partnerships team at [api.partnerships@clio.com](mailto:api.partnerships@clio.com).\n* For best practices and tips from the Clio development community, join the conversation in the [Clio Developer Slack Channel](https://join.slack.com/t/clio-public/shared_invite/zt-36i0eqgo1-7POORPtMJpp2N0~_auL2IQ).\n\nA community-driven [Clio Developers Stack Overflow Group](https://stackoverflow.com/questions/tagged/clio-api) also exists where you can connect and ask questions from other Clio API users.\n# Getting Started\n> **Note:** The API is available in four distinct data regions: Australia (au.app.clio.com), Canada (ca.app.clio.com), EU (eu.app.clio.com) and US (app.clio.com).\n>\n> Likewise, the developer portal is available at region-specific links for the [Australia](https://au.developers.clio.com), [Canada](https://ca.developers.clio.com), [EU](https://eu.developers.clio.com), and [US](https://developers.clio.com) regions.\n>\n> This document assumes the US region is being used (app.clio.com). If you're building in one of the other regions, you should adapt the links and examples as necessary.\n\nTo start building on the Clio API, you’ll need a Clio account – you can review our [Developer Handbook](https://docs.developers.clio.com/) and follow the steps to sign up for an account.\n\nOnce you have an account, you can [create a developer application](https://docs.developers.clio.com/api-docs/applications) from the [Developer Portal](https://developers.clio.com) and start building!\n# Authorization with OAuth 2.0\nSee our [Authorization documentation →](https://docs.developers.clio.com/api-docs/authorization)\n# Permissions\nSee our [Permissions documentation →](https://docs.developers.clio.com/api-docs/permissions)\n# Fields\nSee our [Fields documentation →](https://docs.developers.clio.com/api-docs/fields)\n# Rate Limiting\nSee our [Rate Limits documentation →](https://docs.developers.clio.com/api-docs/rate-limits)\n# Paging\nSee our [Pagination documentation →](https://docs.developers.clio.com/api-docs/paging)\n# ETags\nSee our [ETags documentation →](https://docs.developers.clio.com/api-docs/etags)\n# Minor Versions\nAPI v4 supports multiple minor versions. Versions are of the form '4.X.Y'. To request a specific version, you can use an `X-API-VERSION` header in your request, with the header value set to the API version you're requesting. If this header is omitted, it will be treated as a request for the default API version. If the header is present but invalid, it will return a `410 Gone` response. If the header is present and valid, but it is no longer supported, it will return a `410 Gone` response.\n\nAn `X-API-VERSION` will be included in all successful responses, with the value being set to the API version used.\n\nYou can find our [API Versioning Policy and Guidelines](https://docs.developers.clio.com/api-docs/api-versioning-policy) in our documentation hub.\n\nThe [API Changelog](https://docs.developers.clio.com/api-docs/api-changelog) explains each version's changes in further detail.\n### [4.0.4](https://docs.developers.clio.com/api-docs/api-changelog#404)\n\n * Update `quantity` field to return values in seconds rather than hours for Activities\n\n### [4.0.5](https://docs.developers.clio.com/api-docs/api-changelog#405)\n\n * Remove `matter_balances` field from Bills\n* Standardize status/state enum values\n* Add a Document association to completed DocumentAutomations\n* Add rate visibility handling for Activity's price and total\n\n### [4.0.6](https://docs.developers.clio.com/api-docs/api-changelog#406)\n\n * Remove `document_versions` collection field from Documents\n\n### [4.0.7](https://docs.developers.clio.com/api-docs/api-changelog#407)\n\n * Change secure link format\n\n### [4.0.8](https://docs.developers.clio.com/api-docs/api-changelog#408)\n\n * `Activity` hours are redacted in the response based on the activity hours visibility setting for the user\n * Add `quantity_redacted` field to activities\n\n### [4.0.9](https://docs.developers.clio.com/api-docs/api-changelog#409)\n\n * Contacts are filtered and redacted in the response based on the new 'Contacts Visibility' user permission setting.\n\n### [4.0.10](https://docs.developers.clio.com/api-docs/api-changelog#4010)\n\n * Fixed validation of `type` query parameter when querying Notes\n\n### [4.0.12](https://docs.developers.clio.com/api-docs/api-changelog#4012)\n\n * Restrict fields for CalendarEntry that should only be visible to event owners, editors, and viewers\n\n### [4.0.13](https://docs.developers.clio.com/api-docs/api-changelog#4013)\n\n **This is the default version**\n\n * Add association limits to Contacts\n* Returns 422 Unprocessable Entity when association limits are exceeded\n\n\n"
version: v4
x-logo:
url: https://www.clio.com/wp-content/uploads/2015/05/Container-5-Logo.png
servers:
- url: https://app.clio.com/api/v4
description: US region Production Server
- url: https://eu.app.clio.com/api/v4
description: Europe region Production Server
- url: https://ca.app.clio.com/api/v4
description: Canada region Production Server
- url: https://au.app.clio.com/api/v4
description: Australia region Production Server
tags:
- name: Reminders
description: 'Reminders can be added to Tasks or Calendar Entries. Reminder emails can be sent by a User to themselves, other Users, Clio For Co-Counsel/Clio Connect Contacts, or [any authorized email](https://help.clio.com/hc/en-us/articles/9289861195291-Calendar-Notifications-and-Reminders). An in-Clio pop-up reminder can also be sent by a User to themself.
[Support Link](https://help.clio.com/hc/en-us/articles/9289861195291-Calendar-Notifications-and-Reminders)
'
paths:
/reminders.json:
get:
tags:
- Reminders
summary: Return the data for all Reminders
operationId: Reminder#index
description: Outlines the parameters, optional and required, used when requesting the data for all Reminders
parameters:
- name: X-API-VERSION
in: header
description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
required: false
schema:
type: string
- name: created_since
in: query
description: Filter Reminder records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
required: false
schema:
type: string
format: date-time
- name: fields
in: query
description: The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
required: false
schema:
type: string
- name: ids[]
in: query
description: Filter Reminder records to those having the specified unique identifiers.
required: false
schema:
type: integer
format: int64
- name: limit
in: query
description: 'A limit on the number of Reminder records to be returned. Limit can range between 1 and 200. Default: `200`.'
required: false
schema:
type: integer
format: int32
- name: notification_method_id
in: query
description: The unique identifier for a single NotificationMethod. The keyword `null` is not valid for this field. The list will be filtered to include only the Reminder records with the matching property.
required: false
schema:
type: integer
format: int64
- name: order
in: query
description: 'Orders the Reminder records by the given field. Default: `id(asc)`.'
required: false
schema:
type: string
enum:
- next_delivery_at(asc)
- next_delivery_at(desc)
- id(asc)
- id(desc)
- name: page_token
in: query
description: A token specifying which page to return.
required: false
schema:
type: string
- name: state
in: query
description: Filter Reminder records to those with a given state.
required: false
schema:
type: string
enum:
- initializing
- scheduling
- rescheduling
- scheduled
- attempting_delivery
- delivery_failed
- delivered
- delivery_skipped
- invalid_user
- name: subject_id
in: query
description: The unique identifier for a single CalendarEntry or Task. The keyword `null` is not valid for this field. The list will be filtered to include only the Reminder records with the matching property.
required: false
schema:
type: integer
format: int64
- name: subject_type
in: query
description: Filter Reminder records to those of a given subject type, required if using subject_id.
required: false
schema:
type: string
enum:
- calendar_entry
- task
- name: updated_since
in: query
description: Filter Reminder records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).
required: false
schema:
type: string
format: date-time
- name: user_id
in: query
description: The unique identifier for a single User. The keyword `null` is not valid for this field. The list will be filtered to include only the Reminder records with the matching property.
required: false
schema:
type: integer
format: int64
responses:
'200':
description: Ok
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Reminder_List'
'400':
description: Bad Request
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Too Many Requests
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
post:
tags:
- Reminders
summary: Create a new Reminder
operationId: Reminder#create
description: Outlines the parameters and data fields used when creating a new Reminder
parameters:
- name: X-API-VERSION
in: header
description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
required: false
schema:
type: string
- name: fields
in: query
description: The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
required: false
schema:
type: string
responses:
'201':
description: Created
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Reminder_Show'
'400':
description: Bad Request
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'422':
description: Unprocessable Entity
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Too Many Requests
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
requestBody:
description: Request Body for Reminders
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
duration_unit:
type: string
enum:
- weeks
- days
- hours
- minutes
description: Unit to measure the duration value in.
duration_value:
type: integer
format: int32
description: Time measured in `duration_unit` to remind user before the subject.
notification_method:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single NotificationMethod associated with the Reminder. The keyword `null` is not valid for this field.
required:
- id
subject:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single CalendarEntry and Task associated with the Reminder. The keyword `null` is not valid for this field.
type:
type: string
enum:
- CalendarEntry
- Task
description: Model type of the Subject.
required:
- id
- type
required:
- subject
- notification_method
application/x-www-form-urlencoded:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
duration_unit:
type: string
enum:
- weeks
- days
- hours
- minutes
description: Unit to measure the duration value in.
duration_value:
type: integer
format: int32
description: Time measured in `duration_unit` to remind user before the subject.
notification_method:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single NotificationMethod associated with the Reminder. The keyword `null` is not valid for this field.
required:
- id
subject:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single CalendarEntry and Task associated with the Reminder. The keyword `null` is not valid for this field.
type:
type: string
enum:
- CalendarEntry
- Task
description: Model type of the Subject.
required:
- id
- type
required:
- subject
- notification_method
multipart/form-data:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
duration_unit:
type: string
enum:
- weeks
- days
- hours
- minutes
description: Unit to measure the duration value in.
duration_value:
type: integer
format: int32
description: Time measured in `duration_unit` to remind user before the subject.
notification_method:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single NotificationMethod associated with the Reminder. The keyword `null` is not valid for this field.
required:
- id
subject:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single CalendarEntry and Task associated with the Reminder. The keyword `null` is not valid for this field.
type:
type: string
enum:
- CalendarEntry
- Task
description: Model type of the Subject.
required:
- id
- type
required:
- subject
- notification_method
required: false
/reminders/{id}.json:
get:
tags:
- Reminders
summary: Return the data for a single Reminder
operationId: Reminder#show
description: Outlines the parameters, optional and required, used when requesting the data for a single Reminder
parameters:
- name: IF-MODIFIED-SINCE
in: header
description: The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).
required: false
schema:
type: string
format: date
- name: IF-NONE-MATCH
in: header
description: The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.
required: false
schema:
type: string
- name: X-API-VERSION
in: header
description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
required: false
schema:
type: string
- name: fields
in: query
description: The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
required: false
schema:
type: string
- name: id
in: path
description: The unique identifier for the Reminder.
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Ok
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Reminder_Show'
'400':
description: Bad Request
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Too Many Requests
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'304':
description: Not Modified
patch:
tags:
- Reminders
summary: Update a single Reminder
operationId: Reminder#update
description: Outlines the parameters and data fields used when updating a single Reminder
parameters:
- name: IF-MATCH
in: header
description: The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).
required: false
schema:
type: string
- name: X-API-VERSION
in: header
description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
required: false
schema:
type: string
- name: fields
in: query
description: The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
required: false
schema:
type: string
- name: id
in: path
description: The unique identifier for the Reminder.
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Ok
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Reminder_Show'
'400':
description: Bad Request
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'422':
description: Unprocessable Entity
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Too Many Requests
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'412':
description: Precondition Failed
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
requestBody:
description: Request Body for Reminders
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
duration_unit:
type: string
enum:
- weeks
- days
- hours
- minutes
description: Unit to measure the duration value in.
duration_value:
type: integer
format: int32
description: Time measured in `duration_unit` to remind user before the subject.
notification_method:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single NotificationMethod associated with the Reminder. The keyword `null` is not valid for this field.
application/x-www-form-urlencoded:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
duration_unit:
type: string
enum:
- weeks
- days
- hours
- minutes
description: Unit to measure the duration value in.
duration_value:
type: integer
format: int32
description: Time measured in `duration_unit` to remind user before the subject.
notification_method:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single NotificationMethod associated with the Reminder. The keyword `null` is not valid for this field.
multipart/form-data:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
duration_unit:
type: string
enum:
- weeks
- days
- hours
- minutes
description: Unit to measure the duration value in.
duration_value:
type: integer
format: int32
description: Time measured in `duration_unit` to remind user before the subject.
notification_method:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single NotificationMethod associated with the Reminder. The keyword `null` is not valid for this field.
required: false
delete:
tags:
- Reminders
summary: Delete a single Reminder
operationId: Reminder#destroy
description: Outlines the parameters, optional and required, used when deleting the record for a single Reminder
parameters:
- name: X-API-VERSION
in: header
description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
required: false
schema:
type: string
- name: id
in: path
description: The unique identifier for the Reminder.
required: true
schema:
type: integer
format: int64
responses:
'204':
description: No Content
'403':
description: Forbidden
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Reminder:
allOf:
- $ref: '#/components/schemas/Reminder_base'
- type: object
properties:
notification_method:
$ref: '#/components/schemas/NotificationMethod_base'
description: NotificationMethod
subject:
$ref: '#/components/schemas/PolymorphicObject_base'
description: PolymorphicObject
Error:
type: object
required:
- error
properties:
error:
$ref: '#/components/schemas/ErrorDetail'
Reminder_List:
type: object
required:
- data
properties:
data:
type: array
description: Reminder List Response
items:
$ref: '#/components/schemas/Reminder'
PolymorphicObject_base:
type: object
properties:
id:
type: integer
format: int64
description: Unique identifier for the *PolymorphicObject*
type:
type: string
enum:
- Task
- CalendarEntry
- MatterNote
- ContactNote
- Matter
- Contact
- User
- CreditMemo
- Payment
- Document
- Communication
- Conversation
- TextMessageConversation
description: The type of the *PolymorphicObject*
identifier:
type: string
description: A string to identify the *PolymorphicObject*
secondary_identifier:
type: string
description: A secondary string to identify the *PolymorphicObject*
tertiary_identifier:
type: string
description: A tertiary string to identify the *PolymorphicObject*
Reminder_Show:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/Reminder'
NotificationMethod_base:
type: object
properties:
id:
type: integer
format: int64
description: Unique identifier for the *NotificationMethod*
etag:
type: string
description: ETag for the *NotificationMethod*
type:
type: string
enum:
- Email
- Popup
- SMS
description: Human readable description of the type of notification
email_address:
type: string
description: Email address to send the notification to (only for email type)
is_default_email_address:
type: boolean
description: A boolean that is returned only on notification method objects that are relevant e.g. Email notification or Alternative Email
created_at:
type: string
format: date-time
description: The time the *NotificationMethod* was created (as a ISO-8601 timestamp)
updated_at:
type: string
format: date-time
description: The time the *NotificationMethod* was last updated (as a ISO-8601 timestamp)
Reminder_base:
type: object
properties:
id:
type: integer
format: int64
description: Unique identifier for the *Reminder*
etag:
type: string
description: ETag for the *Reminder*
duration:
type: integer
format: int32
description: Time in minutes to remind user before the subject
next_delivery_at:
type: string
format: date-time
description: The time the *Reminder* will be delivered (as a ISO-8601 timestamp)
state:
type: string
enum
# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clio/refs/heads/main/openapi/clio-reminders-api-openapi.yml