Clio Calendar Entries API

openapi: 3.0.0
info:
  title: Clio API Documentation Activities Calendar Entries 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: Calendar Entries
  description: "Calendar Entries are used to track appointments or deadlines. Users can view Calendar Entries on any Calendar that they have “Viewer” or “Editor” permission for. Users can create Calendar Entries on any Calendar that they have “Editor” permission for.\n### Only supports dates on or after January 01 1900 00:00 UTC\n* If you attempt to create a date before 1900, the year of that date will be pulled forward to 1900 before it's persisted.\n\n### Calendar Update/Deletion Best Practices\n* Prior to updating or deleting a calendar entry, check for recurrence.\n* If the recurrence_rule parameter is not equal to `null`, offer the following 3 options for the update/deletion, as well as the note:\n    1. Only this instance: Update/Delete this event, but leave all future events unchanged.\n    2. All following: Updates/Deletes this event and all the future events.\n    3. All events in the series: Updates/Deletes all events in the series.\n    * Note: If you've modified any future events in this series, those edits will be lost once you make this change.\n\n[Support Link](https://help.clio.com/hc/en-us/articles/9289905071387-Calendar-Events)\n"
paths:
  /calendar_entries.json:
    get:
      tags:
      - Calendar Entries
      summary: Return the data for all CalendarEntries
      operationId: CalendarEntry#index
      description: Outlines the parameters, optional and required, used when requesting the data for all CalendarEntries
      parameters:
      - name: X-API-VERSION
        in: header
        description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
        required: false
        schema:
          type: string
      - name: calendar_id
        in: query
        description: The unique identifier for a single Calendar. The keyword `null` is not valid for this field. The list will be filtered to include only the CalendarEntry records with the matching property.
        required: false
        schema:
          type: integer
          format: int64
      - name: created_since
        in: query
        description: Filter CalendarEntry 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: expanded
        in: query
        description: Returns a record for each occurrence of a recurring calendar event.  Non-recurring calendar events are unaffected and returned as separate records regardless of the expanded setting.
        required: false
        schema:
          type: boolean
      - name: external_property_name
        in: query
        description: 'Filter records to only those with the given external property(s) name set.


          e.g. `?external_property_name=Name`

          '
        required: false
        schema:
          type: string
      - name: external_property_value
        in: query
        description: 'Filter records to only those with the given external property(s) value set. Requires external property name as well.


          e.g. `?external_property_name=Name&external_property_value=Value`

          '
        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: from
        in: query
        description: Filter CalendarEntry records to those that end on or after the provided time (Expects an ISO-8601 timestamp).
        required: false
        schema:
          type: string
          format: date-time
      - name: has_court_rule
        in: query
        description: Allows matching court rule on calendar entry.
        required: false
        schema:
          type: boolean
      - name: ids[]
        in: query
        description: Filter CalendarEntry records to those having the specified unique identifiers.
        required: false
        schema:
          type: integer
          format: int64
      - name: is_all_day
        in: query
        description: Filter CalendarEntry records to those that are marked as all day events.
        required: false
        schema:
          type: boolean
      - name: limit
        in: query
        description: 'A limit on the number of CalendarEntry records to be returned. Limit can range between 1 and 200. Default: `200`.'
        required: false
        schema:
          type: integer
          format: int32
      - name: matter_id
        in: query
        description: The unique identifier for a single Matter. Use the keyword `null` to match those without a CalendarEntry. The list will be filtered to include only the CalendarEntry records with the matching property.
        required: false
        schema:
          type: integer
          format: int64
      - name: owner_entries_across_all_users
        in: query
        description: Returns CalendarEntry records for all users related to a matter. Requires matter id.
        required: false
        schema:
          type: boolean
      - name: page_token
        in: query
        description: A token specifying which page to return.
        required: false
        schema:
          type: string
      - name: query
        in: query
        description: Allows matching search on calendar entry.
        required: false
        schema:
          type: string
      - name: source
        in: query
        description: Filter CalendarEntry records to those having a specific calendar visibility source (mobile, web).
        required: false
        schema:
          type: string
          enum:
          - web
          - mobile
      - name: to
        in: query
        description: Filter CalendarEntry records to those that begin on or before the provided time (Expects an ISO-8601 timestamp).
        required: false
        schema:
          type: string
          format: date-time
      - name: updated_since
        in: query
        description: Filter CalendarEntry 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: visible
        in: query
        description: Filter CalendarEntry records to those that are visible.
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: Ok
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/CalendarEntry_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:
      - Calendar Entries
      summary: Create a new CalendarEntry
      operationId: CalendarEntry#create
      description: Outlines the parameters and data fields used when creating a new CalendarEntry
      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/CalendarEntry_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 Calendar Entries
        content:
          application/json:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: object
                  properties:
                    _deleted:
                      type: string
                      enum:
                      - single
                      - future
                      description: Flag to delete a specific instance of a recurring event.
                    all_day:
                      type: boolean
                      description: Whether or not the CalendarEntry is for all day.
                    attendees:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                            format: int64
                            description: The unique identifier for a single Attendee associated with the CalendarEntry. The keyword `null` is not valid for this field. Not required for creating new Attendee, but required for updating or deleting existing ones.
                          type:
                            type: string
                            description: The type of attendee (Calendar, Contact)
                          _destroy:
                            type: boolean
                            description: Flag to delete a specific attendee.
                    calendar_entry_event_type:
                      type: object
                      properties:
                        id:
                          type: integer
                          format: int64
                          description: The unique identifier for a single CalendarEntryEventType associated with the CalendarEntry. Use the keyword `null` to specify no association.
                    calendar_owner:
                      type: object
                      properties:
                        id:
                          type: integer
                          format: int64
                          description: The unique identifier for a single Calendar associated with the CalendarEntry. The keyword `null` is not valid for this field.
                      required:
                      - id
                    conference_meeting:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - zoom
                          description: The type of conference meeting. If no conference meeting is present or the user is in an ineligible pricing tier for this feature, it will be null.
                    description:
                      type: string
                      description: A detailed description of the CalendarEntry.
                    end_at:
                      type: string
                      format: date-time
                      description: The time the CalendarEntry ends (Expects an ISO-8601 timestamp).
                    external_properties:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                            description: 'The ExternalProperty name. Note: **there is a limit of 5 external_properties per CalendarEntry**'
                          value:
                            type: string
                            description: The ExternalProperty value.
                    location:
                      type: string
                      description: The geographic location of the CalendarEntry.
                    matter:
                      type: object
                      properties:
                        id:
                          type: integer
                          format: int64
                          description: The unique identifier for a single Matter associated with the CalendarEntry. Use the keyword `null` to specify no association.
                    recurrence_rule:
                      type: string
                      description: Recurrence rule for expanding recurring CalendarEntry. To convert an existing recurring event to a non-recurring event, `''` or `null` are valid values.
                    send_email_notification:
                      type: boolean
                      description: Whether the calendar Entry should send email notifications to attendees
                    start_at:
                      type: string
                      format: date-time
                      description: The time the CalendarEntry starts (Expects an ISO-8601 timestamp).
                    summary:
                      type: string
                      description: A short summary of the CalendarEntry.
                  required:
                  - summary
                  - start_at
                  - end_at
                  - calendar_owner
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: object
                  properties:
                    _deleted:
                      type: string
                      enum:
                      - single
                      - future
                      description: Flag to delete a specific instance of a recurring event.
                    all_day:
                      type: boolean
                      description: Whether or not the CalendarEntry is for all day.
                    attendees:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                            format: int64
                            description: The unique identifier for a single Attendee associated with the CalendarEntry. The keyword `null` is not valid for this field. Not required for creating new Attendee, but required for updating or deleting existing ones.
                          type:
                            type: string
                            description: The type of attendee (Calendar, Contact)
                          _destroy:
                            type: boolean
                            description: Flag to delete a specific attendee.
                    calendar_entry_event_type:
                      type: object
                      properties:
                        id:
                          type: integer
                          format: int64
                          description: The unique identifier for a single CalendarEntryEventType associated with the CalendarEntry. Use the keyword `null` to specify no association.
                    calendar_owner:
                      type: object
                      properties:
                        id:
                          type: integer
                          format: int64
                          description: The unique identifier for a single Calendar associated with the CalendarEntry. The keyword `null` is not valid for this field.
                      required:
                      - id
                    conference_meeting:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - zoom
                          description: The type of conference meeting. If no conference meeting is present or the user is in an ineligible pricing tier for this feature, it will be null.
                    description:
                      type: string
                      description: A detailed description of the CalendarEntry.
                    end_at:
                      type: string
                      format: date-time
                      description: The time the CalendarEntry ends (Expects an ISO-8601 timestamp).
                    external_properties:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                            description: 'The ExternalProperty name. Note: **there is a limit of 5 external_properties per CalendarEntry**'
                          value:
                            type: string
                            description: The ExternalProperty value.
                    location:
                      type: string
                      description: The geographic location of the CalendarEntry.
                    matter:
                      type: object
                      properties:
                        id:
                          type: integer
                          format: int64
                          description: The unique identifier for a single Matter associated with the CalendarEntry. Use the keyword `null` to specify no association.
                    recurrence_rule:
                      type: string
                      description: Recurrence rule for expanding recurring CalendarEntry. To convert an existing recurring event to a non-recurring event, `''` or `null` are valid values.
                    send_email_notification:
                      type: boolean
                      description: Whether the calendar Entry should send email notifications to attendees
                    start_at:
                      type: string
                      format: date-time
                      description: The time the CalendarEntry starts (Expects an ISO-8601 timestamp).
                    summary:
                      type: string
                      description: A short summary of the CalendarEntry.
                  required:
                  - summary
                  - start_at
                  - end_at
                  - calendar_owner
          multipart/form-data:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: object
                  properties:
                    _deleted:
                      type: string
                      enum:
                      - single
                      - future
                      description: Flag to delete a specific instance of a recurring event.
                    all_day:
                      type: boolean
                      description: Whether or not the CalendarEntry is for all day.
                    attendees:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                            format: int64
                            description: The unique identifier for a single Attendee associated with the CalendarEntry. The keyword `null` is not valid for this field. Not required for creating new Attendee, but required for updating or deleting existing ones.
                          type:
                            type: string
                            description: The type of attendee (Calendar, Contact)
                          _destroy:
                            type: boolean
                            description: Flag to delete a specific attendee.
                    calendar_entry_event_type:
                      type: object
                      properties:
                        id:
                          type: integer
                          format: int64
                          description: The unique identifier for a single CalendarEntryEventType associated with the CalendarEntry. Use the keyword `null` to specify no association.
                    calendar_owner:
                      type: object
                      properties:
                        id:
                          type: integer
                          format: int64
                          description: The unique identifier for a single Calendar associated with the CalendarEntry. The keyword `null` is not valid for this field.
                      required:
                      - id
                    conference_meeting:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - zoom
                          description: The type of conference meeting. If no conference meeting is present or the user is in an ineligible pricing tier for this feature, it will be null.
                    description:
                      type: string
                      description: A detailed description of the CalendarEntry.
                    end_at:
                      type: string
                      format: date-time
                      description: The time the CalendarEntry ends (Expects an ISO-8601 timestamp).
                    external_properties:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                            description: 'The ExternalProperty name. Note: **there is a limit of 5 external_properties per CalendarEntry**'
                          value:
                            type: string
                            description: The ExternalProperty value.
                    location:
                      type: string
                      description: The geographic location of the CalendarEntry.
                    matter:
                      type: object
                      properties:
                        id:
                          type: integer
                          format: int64
                          description: The unique identifier for a single Matter associated with the CalendarEntry. Use the keyword `null` to specify no association.
                    recurrence_rule:
                      type: string
                      description: Recurrence rule for expanding recurring CalendarEntry. To convert an existing recurring event to a non-recurring event, `''` or `null` are valid values.
                    send_email_notification:
                      type: boolean
                      description: Whether the calendar Entry should send email notifications to attendees
                    start_at:
                      type: string
                      format: date-time
                      description: The time the CalendarEntry starts (Expects an ISO-8601 timestamp).
                    summary:
                      type: string
                      description: A short summary of the CalendarEntry.
                  required:
                  - summary
                  - start_at
                  - end_at
                  - calendar_owner
        required: false
  /calendar_entries/{id}.json:
    get:
      tags:
      - Calendar Entries
      summary: Return the data for a single CalendarEntry
      operationId: CalendarEntry#show
      description: Outlines the parameters, optional and required, used when requesting the data for a single CalendarEntry
      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 CalendarEntry.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Ok
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/CalendarEntry_Show'
        '400':
          description: Bad Request
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json; charse

# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clio/refs/heads/main/openapi/clio-calendar-entries-api-openapi.yml