> ## Documentation Index
> Fetch the complete documentation index at: https://docs.decodahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Shifts By Date

> Get all shifts for a specific date with provider information



## OpenAPI

````yaml get /check-in/calendar/shifts/by-date
openapi: 3.1.0
info:
  title: Decoda API
  description: External API documentation for the Decoda Health platform.
  version: '1.0'
servers: []
security: []
paths:
  /check-in/calendar/shifts/by-date:
    get:
      tags:
        - Calendar and Appointments
      summary: Get Shifts By Date
      description: Get all shifts for a specific date with provider information
      operationId: get_shifts_by_date_check_in_calendar_shifts_by_date_get
      parameters:
        - name: TENANT
          in: header
          required: true
          schema:
            type: string
            title: Tenant
          description: The tenant you are making this request on behalf of
        - name: API-KEY
          in: header
          required: true
          schema:
            type: string
            title: Api-Key
          description: Your api key
        - name: date
          in: query
          required: true
          schema:
            type: string
            description: Date in YYYY-MM-DD format
            title: Date
          description: Date in YYYY-MM-DD format
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShiftsByDateResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ShiftsByDateResponse:
      properties:
        date:
          type: string
          title: Date
        providers:
          items:
            $ref: '#/components/schemas/ProviderShiftsData'
          type: array
          title: Providers
      type: object
      required:
        - date
        - providers
      title: ShiftsByDateResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ProviderShiftsData:
      properties:
        provider:
          $ref: '#/components/schemas/ProviderTiny'
        shifts:
          items:
            $ref: '#/components/schemas/EventTiny'
          type: array
          title: Shifts
        appointments:
          items:
            $ref: '#/components/schemas/EventTiny'
          type: array
          title: Appointments
      type: object
      required:
        - provider
        - shifts
        - appointments
      title: ProviderShiftsData
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ProviderTiny:
      properties:
        id:
          type: string
          title: Id
        firstName:
          type: string
          title: Firstname
        lastName:
          anyOf:
            - type: string
            - type: 'null'
          title: Lastname
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
        createdDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Createddate
      type: object
      required:
        - id
        - firstName
      title: ProviderTiny
    EventTiny:
      properties:
        id:
          type: string
          title: Id
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
        start:
          type: string
          format: date-time
          title: Start
        end:
          type: string
          format: date-time
          title: End
        type:
          $ref: '#/components/schemas/EventType'
        isAllDay:
          type: boolean
          title: Isallday
          default: false
        location:
          anyOf:
            - $ref: '#/components/schemas/LocationTiny'
            - type: 'null'
        roomId:
          anyOf:
            - type: string
            - type: 'null'
          title: Roomid
        attendees:
          items:
            $ref: '#/components/schemas/AttendeeDetail'
          type: array
          title: Attendees
          default: []
        status:
          $ref: '#/components/schemas/EventStatus'
        recurringEventId:
          anyOf:
            - type: string
            - type: 'null'
          title: Recurringeventid
        recurringEvent:
          anyOf:
            - $ref: '#/components/schemas/RecurringEventDetail'
            - type: 'null'
        segments:
          items:
            oneOf:
              - $ref: '#/components/schemas/EventServiceTiny'
              - $ref: '#/components/schemas/EventBookableSegmentTiny'
              - $ref: '#/components/schemas/EventPrepSegmentTiny'
              - $ref: '#/components/schemas/EventCleanupSegmentTiny'
          type: array
          title: Segments
          default: []
        icons:
          items:
            $ref: '#/components/schemas/EventIcon'
          type: array
          title: Icons
          default: []
        capacity:
          anyOf:
            - type: integer
            - type: 'null'
          title: Capacity
        quickNotes:
          anyOf:
            - items:
                $ref: '#/components/schemas/QuickNoteSummary'
              type: array
            - type: 'null'
          title: Quicknotes
        carePlan:
          anyOf:
            - $ref: '#/components/schemas/CarePlanStepTiny'
            - type: 'null'
        createdDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Createddate
        updatedDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updateddate
        meetingLink:
          anyOf:
            - type: string
            - type: 'null'
          title: Meetinglink
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        gcalBusy:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Gcalbusy
        patientRequestedProvider:
          type: boolean
          title: Patientrequestedprovider
          default: false
        isBusinessBlock:
          type: boolean
          title: Isbusinessblock
          default: false
      type: object
      required:
        - id
        - start
        - end
        - type
        - status
      title: EventTiny
    EventType:
      type: string
      enum:
        - APPOINTMENT
        - SHIFT
        - BLOCK
        - GOOGLE_CALENDAR
      title: EventType
    LocationTiny:
      properties:
        id:
          type: string
          title: Id
        isVirtual:
          type: boolean
          title: Isvirtual
      type: object
      required:
        - id
        - isVirtual
      title: LocationTiny
    AttendeeDetail:
      properties:
        user:
          $ref: '#/components/schemas/UserTiny'
        inviteStatus:
          $ref: '#/components/schemas/InviteStatus'
      type: object
      required:
        - user
        - inviteStatus
      title: AttendeeDetail
    EventStatus:
      type: string
      enum:
        - PENDING
        - RESERVED
        - CONFIRMED
        - CANCELLED
        - COMPLETED
        - OVERRIDABLE
        - NO_SHOW
      title: EventStatus
    RecurringEventDetail:
      properties:
        id:
          type: string
          title: Id
        rrule:
          type: string
          title: Rrule
        startDate:
          type: string
          format: date-time
          title: Startdate
        durationMinutes:
          type: integer
          title: Durationminutes
        timezone:
          type: string
          title: Timezone
        segments:
          anyOf:
            - items:
                $ref: '#/components/schemas/RecurringEventSegmentTemplate'
              type: array
            - type: 'null'
          title: Segments
        serviceIds:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Serviceids
        bookableIds:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Bookableids
        capacity:
          anyOf:
            - type: integer
            - type: 'null'
          title: Capacity
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        patientRequestedProvider:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Patientrequestedprovider
        isBusinessBlock:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Isbusinessblock
        type:
          $ref: '#/components/schemas/EventType'
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
        attendeeIds:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Attendeeids
        locationId:
          anyOf:
            - type: string
            - type: 'null'
          title: Locationid
        externalId:
          anyOf:
            - type: string
            - type: 'null'
          title: Externalid
        organizerId:
          type: string
          title: Organizerid
      type: object
      required:
        - id
        - rrule
        - startDate
        - durationMinutes
        - timezone
        - type
        - organizerId
      title: RecurringEventDetail
    EventServiceTiny:
      properties:
        id:
          type: string
          title: Id
        type:
          type: string
          const: SERVICE
          title: Type
          default: SERVICE
        eventId:
          type: string
          title: Eventid
        start:
          type: string
          format: date-time
          title: Start
        end:
          type: string
          format: date-time
          title: End
        externalId:
          anyOf:
            - type: string
            - type: 'null'
          title: Externalid
        isArchived:
          type: boolean
          title: Isarchived
          default: false
        createdDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Createddate
        updatedDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updateddate
        service:
          $ref: '#/components/schemas/ServiceTiny'
        providerId:
          anyOf:
            - type: string
            - type: 'null'
          title: Providerid
        provider:
          anyOf:
            - $ref: '#/components/schemas/ProviderTiny'
            - type: 'null'
        serviceAddonId:
          anyOf:
            - type: string
            - type: 'null'
          title: Serviceaddonid
      type: object
      required:
        - id
        - eventId
        - start
        - end
        - service
      title: EventServiceTiny
      description: Service segment response for list views.
    EventBookableSegmentTiny:
      properties:
        id:
          type: string
          title: Id
        type:
          type: string
          const: BOOKABLE
          title: Type
          default: BOOKABLE
        eventId:
          type: string
          title: Eventid
        start:
          type: string
          format: date-time
          title: Start
        end:
          type: string
          format: date-time
          title: End
        externalId:
          anyOf:
            - type: string
            - type: 'null'
          title: Externalid
        isArchived:
          type: boolean
          title: Isarchived
          default: false
        createdDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Createddate
        updatedDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updateddate
        bookableId:
          type: string
          title: Bookableid
        bookableGroupId:
          anyOf:
            - type: string
            - type: 'null'
          title: Bookablegroupid
        bookable:
          anyOf:
            - $ref: '#/components/schemas/BookableTiny'
            - type: 'null'
        eventType:
          anyOf:
            - $ref: '#/components/schemas/EventType'
            - type: 'null'
      type: object
      required:
        - id
        - eventId
        - start
        - end
        - bookableId
      title: EventBookableSegmentTiny
      description: >-
        Bookable segment response.


        ``bookable_group_id`` is set when this segment was picked from a

        :class:`BookableGroup` (OR-semantic alternatives). The frontend
        round-trips

        the group id so reschedules / edits can re-pick from the same group
        instead

        of pinning the originally-chosen member.
    EventPrepSegmentTiny:
      properties:
        id:
          type: string
          title: Id
        type:
          type: string
          const: PREP
          title: Type
          default: PREP
        eventId:
          type: string
          title: Eventid
        start:
          type: string
          format: date-time
          title: Start
        end:
          type: string
          format: date-time
          title: End
        externalId:
          anyOf:
            - type: string
            - type: 'null'
          title: Externalid
        isArchived:
          type: boolean
          title: Isarchived
          default: false
        createdDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Createddate
        updatedDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updateddate
        providerId:
          anyOf:
            - type: string
            - type: 'null'
          title: Providerid
        provider:
          anyOf:
            - $ref: '#/components/schemas/ProviderTiny'
            - type: 'null'
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
        color:
          anyOf:
            - type: string
            - type: 'null'
          title: Color
      type: object
      required:
        - id
        - eventId
        - start
        - end
      title: EventPrepSegmentTiny
      description: Prep segment response.
    EventCleanupSegmentTiny:
      properties:
        id:
          type: string
          title: Id
        type:
          type: string
          const: CLEANUP
          title: Type
          default: CLEANUP
        eventId:
          type: string
          title: Eventid
        start:
          type: string
          format: date-time
          title: Start
        end:
          type: string
          format: date-time
          title: End
        externalId:
          anyOf:
            - type: string
            - type: 'null'
          title: Externalid
        isArchived:
          type: boolean
          title: Isarchived
          default: false
        createdDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Createddate
        updatedDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updateddate
        providerId:
          anyOf:
            - type: string
            - type: 'null'
          title: Providerid
        provider:
          anyOf:
            - $ref: '#/components/schemas/ProviderTiny'
            - type: 'null'
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
        color:
          anyOf:
            - type: string
            - type: 'null'
          title: Color
      type: object
      required:
        - id
        - eventId
        - start
        - end
      title: EventCleanupSegmentTiny
      description: Cleanup segment response.
    EventIcon:
      type: string
      enum:
        - BOOKING_FEE_PAID
        - NEW_PATIENT
        - SCHEDULED_BY_AI
        - FORM_COMPLETED
        - FORM_NOT_COMPLETED
        - CHECKED_IN
        - ONLINE_BOOKING
        - NOTE_LINKED
        - PROVIDER_REQUESTED
      title: EventIcon
    QuickNoteSummary:
      properties:
        id:
          type: string
          title: Id
        patientId:
          type: string
          title: Patientid
        note:
          type: string
          title: Note
        creator:
          $ref: '#/components/schemas/UserTiny'
        eventId:
          anyOf:
            - type: string
            - type: 'null'
          title: Eventid
        externalId:
          anyOf:
            - type: string
            - type: 'null'
          title: Externalid
        createdDate:
          type: string
          format: date-time
          title: Createddate
        updatedDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updateddate
        isArchived:
          type: boolean
          title: Isarchived
          default: false
        isPinned:
          type: boolean
          title: Ispinned
          default: false
      type: object
      required:
        - id
        - patientId
        - note
        - creator
        - createdDate
      title: QuickNoteSummary
    CarePlanStepTiny:
      properties:
        carePlanId:
          type: string
          title: Careplanid
        stepNumber:
          type: integer
          title: Stepnumber
        carePlanName:
          type: string
          title: Careplanname
        status:
          type: string
          title: Status
      type: object
      required:
        - carePlanId
        - stepNumber
        - carePlanName
        - status
      title: CarePlanStepTiny
      description: Minimal care-plan step reference for task/event display.
    UserTiny:
      properties:
        id:
          type: string
          title: Id
          description: The unique identifier for the user.
        firstName:
          anyOf:
            - type: string
            - type: 'null'
          title: Firstname
          description: The user's first name.
        lastName:
          anyOf:
            - type: string
            - type: 'null'
          title: Lastname
          description: The user's last name.
        phoneNumber:
          anyOf:
            - type: string
            - type: 'null'
          title: Phonenumber
          description: The user's phone number.
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
          description: The user's email address.
        type:
          $ref: '#/components/schemas/UserType'
          description: The type of user.
        locationId:
          anyOf:
            - type: string
            - type: 'null'
          title: Locationid
          description: The location of the user.
      type: object
      required:
        - id
        - type
      title: UserTiny
    InviteStatus:
      type: string
      enum:
        - PENDING
        - ACCEPTED
        - REJECTED
      title: InviteStatus
    RecurringEventSegmentTemplate:
      properties:
        type:
          $ref: '#/components/schemas/EventSegmentType'
        serviceId:
          anyOf:
            - type: string
            - type: 'null'
          title: Serviceid
        bookableId:
          anyOf:
            - type: string
            - type: 'null'
          title: Bookableid
        bookableGroupId:
          anyOf:
            - type: string
            - type: 'null'
          title: Bookablegroupid
        providerId:
          anyOf:
            - type: string
            - type: 'null'
          title: Providerid
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
        color:
          anyOf:
            - type: string
            - type: 'null'
          title: Color
        durationMinutes:
          anyOf:
            - type: integer
            - type: 'null'
          title: Durationminutes
        bufferMinutes:
          anyOf:
            - type: integer
            - type: 'null'
          title: Bufferminutes
        offsetMinutes:
          anyOf:
            - type: integer
            - type: 'null'
          title: Offsetminutes
      type: object
      required:
        - type
      title: RecurringEventSegmentTemplate
      description: Template for any segment type in recurring events.
    ServiceTiny:
      properties:
        id:
          type: string
          title: Id
        duration:
          type: integer
          title: Duration
        name:
          type: string
          title: Name
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        locationIds:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Locationids
        color:
          type: string
          title: Color
        price:
          anyOf:
            - type: integer
            - type: 'null'
          title: Price
        displayPrice:
          anyOf:
            - type: integer
            - type: 'null'
          title: Displayprice
        displayPriceMax:
          anyOf:
            - type: integer
            - type: 'null'
          title: Displaypricemax
        priceStartsAt:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Pricestartsat
          default: false
        image:
          anyOf:
            - type: string
            - type: 'null'
          title: Image
        imageUrl:
          anyOf:
            - type: string
            - type: 'null'
          title: Imageurl
        estimated:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Estimated
          default: false
        originalDisplayPrice:
          anyOf:
            - type: integer
            - type: 'null'
          title: Originaldisplayprice
        originalDisplayPriceMax:
          anyOf:
            - type: integer
            - type: 'null'
          title: Originaldisplaypricemax
        promotionId:
          anyOf:
            - type: string
            - type: 'null'
          title: Promotionid
        promotionName:
          anyOf:
            - type: string
            - type: 'null'
          title: Promotionname
        promotionDescription:
          anyOf:
            - type: string
            - type: 'null'
          title: Promotiondescription
        promotionDiscountAmount:
          anyOf:
            - type: integer
            - type: 'null'
          title: Promotiondiscountamount
        promotionDiscountPercentage:
          anyOf:
            - type: number
            - type: 'null'
          title: Promotiondiscountpercentage
        noShowFee:
          anyOf:
            - type: integer
            - type: 'null'
          title: Noshowfee
          default: 0
        noShowFeePercentage:
          anyOf:
            - type: integer
              maximum: 100
              minimum: 0
            - type: 'null'
          title: Noshowfeepercentage
        prepTimeDuration:
          anyOf:
            - type: integer
            - type: 'null'
          title: Preptimeduration
        prepTimeBuffer:
          anyOf:
            - type: integer
            - type: 'null'
          title: Preptimebuffer
        prepTimeName:
          anyOf:
            - type: string
            - type: 'null'
          title: Preptimename
        prepTimeColor:
          anyOf:
            - type: string
            - type: 'null'
          title: Preptimecolor
        prepTimeRequiresPatient:
          type: boolean
          title: Preptimerequirespatient
          default: true
        prepProviderIds:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Prepproviderids
        cleanupTimeDuration:
          anyOf:
            - type: integer
            - type: 'null'
          title: Cleanuptimeduration
        cleanupTimeName:
          anyOf:
            - type: string
            - type: 'null'
          title: Cleanuptimename
        cleanupTimeColor:
          anyOf:
            - type: string
            - type: 'null'
          title: Cleanuptimecolor
        cleanupProviderIds:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Cleanupproviderids
        bookables:
          anyOf:
            - items:
                $ref: '#/components/schemas/ServiceBookableItem'
              type: array
            - type: 'null'
          title: Bookables
        bookableGroups:
          anyOf:
            - items:
                $ref: '#/components/schemas/ServiceBookableGroupItem'
              type: array
            - type: 'null'
          title: Bookablegroups
        allowLastItemCompletion:
          type: boolean
          title: Allowlastitemcompletion
          default: true
        noteTemplateId:
          anyOf:
            - type: string
            - type: 'null'
          title: Notetemplateid
        defaultCptCode:
          anyOf:
            - type: string
            - type: 'null'
          title: Defaultcptcode
        defaultModifiers:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Defaultmodifiers
        defaultIcd10Codes:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Defaulticd10Codes
        defaultPlaceOfService:
          anyOf:
            - type: string
            - type: 'null'
          title: Defaultplaceofservice
      type: object
      required:
        - id
        - duration
        - name
        - color
      title: ServiceTiny
    BookableTiny:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
      type: object
      required:
        - id
        - name
      title: BookableTiny
      description: Lightweight bookable for list views.
    UserType:
      type: string
      enum:
        - PROVIDER
        - PATIENT
        - ASSISTANT
      title: UserType
    EventSegmentType:
      type: string
      enum:
        - BOOKABLE
        - SERVICE
        - PREP
        - CLEANUP
      title: EventSegmentType
      description: Discriminator values for EventSegment STI hierarchy.
    ServiceBookableItem:
      properties:
        bookableId:
          type: string
          title: Bookableid
        startOffset:
          type: integer
          maximum: 10080
          minimum: 0
          title: Startoffset
          default: 0
        duration:
          anyOf:
            - type: integer
              maximum: 10080
              minimum: 1
            - type: 'null'
          title: Duration
      type: object
      required:
        - bookableId
      title: ServiceBookableItem
      description: Schema for a bookable resource configured on a service.
    ServiceBookableGroupItem:
      properties:
        bookableGroupId:
          anyOf:
            - type: string
            - type: 'null'
          title: Bookablegroupid
        bookableIds:
          items:
            type: string
          type: array
          title: Bookableids
        startOffset:
          type: integer
          maximum: 10080
          minimum: 0
          title: Startoffset
          default: 0
        duration:
          anyOf:
            - type: integer
              maximum: 10080
              minimum: 1
            - type: 'null'
          title: Duration
      type: object
      title: ServiceBookableGroupItem
      description: >-
        Schema for a bookable group configured on a service.


        Like :class:`ServiceBookableItem` but for the OR-semantic "pick one of
        these

        bookables" case. ``bookable_group_id`` may be ``None`` on a create
        payload

        when the group is being created inline (in which case ``bookable_ids``

        carries the members); the response always has ``bookable_group_id`` set.

````