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

# Read a connection schedule

> Read the recurring run set on a partner endpoint you own: its cadence, whether it is paused and why, when it runs next and what its last scheduled run found.



## OpenAPI

````yaml /openapi/public-api.json get /connections/{id}/schedule
openapi: 3.1.0
info:
  title: ChargerDojo public API
  version: 1.0.0
  description: >-
    Automate ChargerDojo with a cdojo_ API key: register partner endpoints, run
    conformance suites and charging journeys, and read the graded reports.
servers:
  - url: https://chargerdojo.com/api/v1
security:
  - apiKey: []
tags:
  - name: Connections
  - name: Testing
  - name: Reports
  - name: Usage
  - name: Journeys
paths:
  /connections/{id}/schedule:
    get:
      tags:
        - Connections
      summary: Read the run schedule of an owned connection
      description: >-
        Read the recurring run set on a partner endpoint you own: its cadence,
        whether it is paused and why, when it runs next and what its last
        scheduled run found.
      operationId: connections_schedule_get
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            Identifier from the path. Owner scoped: another owner's id answers
            404.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schedule'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found, or owned by another account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    Schedule:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
        data:
          type: object
          required:
            - cadence
            - hourUtc
            - enabled
            - dueAt
            - createdByExternalId
            - missedOccurrences
          properties:
            journey:
              type: object
              required:
                - templateId
                - pairedTargetId
              description: >-
                Set when the schedule runs a paired hub relay journey instead of
                a sweep.
              properties:
                templateId:
                  type: string
                pairedTargetId:
                  type: string
            cadence:
              type: string
              enum:
                - daily
                - weekly
            hourUtc:
              type: integer
              minimum: 0
              maximum: 23
            weekday:
              type: integer
              minimum: 0
              maximum: 6
              description: Sunday is 0. Weekly only.
            enabled:
              type: boolean
            dueAt:
              type: string
              format: date-time
              description: The next occurrence.
            createdByExternalId:
              type: string
            alertToExternalId:
              type: string
            lastMailAttempt:
              type: object
              description: The last alert mail this schedule tried to send, and its result.
              additionalProperties: true
            lastRunAt:
              type: string
              format: date-time
            lastReportId:
              type: string
              description: The run later occurrences compare with.
            lastOutcomeReportId:
              type: string
              description: The run the last outcome describes.
            lastOutcome:
              type: string
              enum:
                - first_run
                - no_change
                - regressed
                - roster_moved
                - unreachable
                - not_graded
                - quota
                - refused
                - deferred
            lastOutcomeAt:
              type: string
              format: date-time
            lastOutcomeCheckTotal:
              type: integer
            lastOutcomeCheckPassed:
              type: integer
            lastOutcomeCheckFailed:
              type: integer
            lastOutcomeCheckWarned:
              type: integer
            lastOutcomeCheckUnobservable:
              type: integer
            lastOutcomeCheckGraded:
              type: integer
            lastOutcomeRegressedCount:
              type: integer
            lastOutcomeBaselineAt:
              type: string
              format: date-time
            lastOutcomeNewWarningCount:
              type: integer
            missedOccurrences:
              type: integer
              description: >-
                Occurrences skipped because they would have run more than one
                cadence late.
            pausedReason:
              type: string
              enum:
                - plan_lapsed
                - connection_unregistered
                - address_not_a_member
                - creator_not_a_member
                - hub_pair_unavailable
                - journey_recovery_required
        meta:
          type: object
          description: Paging, on the operations that return a list.
          properties:
            limit:
              type: integer
            skip:
              type: integer
            nextCursor:
              type: string
          additionalProperties: true
    Error:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          enum:
            - false
        message:
          type: string
        status:
          type: string
          enum:
            - error
        code:
          type: string
        timestamp:
          type: string
          format: date-time
        capability:
          type: string
          enum:
            - external-endpoints
            - ci-handoff
            - saved-presets
            - roaming-hub-identity
            - load-testing
            - direct-payment
            - bookings
            - scheduled-runs
            - roaming-hub-relay
            - partner-profiles
        limit:
          type: object
          required:
            - id
            - used
            - cap
          properties:
            id:
              type: string
              enum:
                - connections
                - run-concurrency
            used:
              type: integer
            cap:
              type: integer
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: A cdojo_... API key created in the app under Settings.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.