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

# List HOS Rulesets

> Get a paginated list of Hours of Service (HOS) rulesets reference data



## OpenAPI

````yaml https://api.catenatelematics.com/v2/telematics/openapi.json get /v2/telematics/ref-hos-rulesets
openapi: 3.1.0
info:
  title: Telematics Data Service - REST API
  description: Telematics Data Service REST API.
  version: 0.1.0
servers:
  - url: https://api.catenatelematics.com
    description: Catena Telematics API
security: []
tags:
  - name: Fleet Operations & Tracking
    description: >-
      Endpoints for tracking vehicles, trailers, assets, and trip activity —
      including locations, movements, and operational telemetry. Useful for
      monitoring utilization and real-time operational status.
  - name: Safety & Driver Behavior
    description: >-
      Endpoints that provide safety-related insights such as harsh braking,
      speeding, and other driver behavior events. Supports risk analysis and
      safety program automation.
  - name: Compliance & Regulation
    description: >-
      Endpoints covering regulated requirements including DVIR inspections,
      Hours of Service (HOS), violations, and IFTA fuel tax reporting. Helps
      organizations meet DOT/FMCSA and interstate regulatory obligations.
  - name: Maintenance & Vehicle Health
    description: >-
      Endpoints providing data for vehicle condition monitoring and maintenance
      workflows, such as DVIR defects and diagnostic sensor events. Enables
      early issue detection and reduced downtime.
  - name: Drivers & Users
    description: >-
      Endpoints related to driver and user identities, assignments, and
      operational context. Supports linking operational and safety data to
      specific individuals.
  - name: Reference Data (Supporting Tables)
    description: >-
      Lookup tables and enumerations that supply standardized codes, metadata,
      and classifications used across the API.
  - name: Analytics (deprecated)
    description: >-
      Endpoints providing analytical insights and aggregated data for vehicles,
      fleets, drivers, and trailers.
paths:
  /v2/telematics/ref-hos-rulesets:
    get:
      tags:
        - Reference Data (Supporting Tables)
      summary: List HOS Rulesets
      description: Get a paginated list of Hours of Service (HOS) rulesets reference data
      operationId: list_rulesets_reference
      parameters:
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Cursor for the next page
            title: Cursor
          description: Cursor for the next page
        - name: size
          in: query
          required: false
          schema:
            type: integer
            maximum: 1000
            minimum: 1
            description: Page size
            default: 300
            title: Size
          description: Page size
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/_CursorPage_RefHosRuleset_'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
          description: Not Found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowed'
          description: Method Not Allowed
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Conflict'
          description: Conflict
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntity'
          description: Unprocessable Entity
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequests'
          description: Too Many Requests
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotImplementedResponse'
          description: Not Implemented
      security:
        - Bearer:
            - telematics:read
components:
  schemas:
    _CursorPage_RefHosRuleset_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/RefHosRuleset'
          type: array
          title: Items
        total:
          type: integer
          minimum: 0
          title: Total
        current_page:
          anyOf:
            - type: string
            - type: 'null'
          title: Current Page
          description: Cursor to refetch the current page
        current_page_backwards:
          anyOf:
            - type: string
            - type: 'null'
          title: Current Page Backwards
          description: Cursor to refetch the current page starting from the last item
        previous_page:
          anyOf:
            - type: string
            - type: 'null'
          title: Previous Page
          description: Cursor for the previous page
        next_page:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Page
          description: Cursor for the next page
      type: object
      required:
        - items
        - total
      title: _CursorPage[RefHosRuleset]
    BadRequest:
      properties:
        code:
          type: integer
          title: Code
          default: 400
        message:
          type: string
          title: Message
          default: Bad Request
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
      type: object
      title: BadRequest
    Unauthorized:
      properties:
        code:
          type: integer
          title: Code
          default: 401
        message:
          type: string
          title: Message
          default: Unauthorized
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
      type: object
      title: Unauthorized
    Forbidden:
      properties:
        code:
          type: integer
          title: Code
          default: 403
        message:
          type: string
          title: Message
          default: Forbidden
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
      type: object
      title: Forbidden
    NotFound:
      properties:
        code:
          type: integer
          title: Code
          default: 404
        message:
          type: string
          title: Message
          default: Not Found
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
      type: object
      title: NotFound
    MethodNotAllowed:
      properties:
        code:
          type: integer
          title: Code
          default: 405
        message:
          type: string
          title: Message
          default: Method Not Allowed
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
      type: object
      title: MethodNotAllowed
    Conflict:
      properties:
        code:
          type: integer
          title: Code
          default: 409
        message:
          type: string
          title: Message
          default: Conflict
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
      type: object
      title: Conflict
    UnprocessableEntity:
      properties:
        code:
          type: integer
          title: Code
          default: 422
        message:
          type: string
          title: Message
          default: Invalid Request Body
        detail:
          anyOf:
            - items:
                $ref: '#/components/schemas/ValidationErrorDetail'
              type: array
            - type: 'null'
          title: Detail
      type: object
      title: UnprocessableEntity
    TooManyRequests:
      properties:
        code:
          type: integer
          title: Code
          default: 429
        message:
          type: string
          title: Message
          default: Too Many Requests
        detail:
          anyOf:
            - $ref: '#/components/schemas/RetryAfterDetail'
            - type: 'null'
      type: object
      title: TooManyRequests
    InternalServerError:
      properties:
        message:
          type: string
          title: Message
          default: Internal Server Error
      type: object
      title: InternalServerError
    NotImplementedResponse:
      properties:
        code:
          type: integer
          title: Code
          default: 501
        message:
          type: string
          title: Message
          default: Not Implemented
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
      type: object
      title: NotImplementedResponse
    RefHosRuleset:
      properties:
        hos_ruleset_code:
          type: string
          title: Hos Ruleset Code
          description: Stable identifier for the HOS Cycle Ruleset (normalized slug).
        hos_ruleset_name:
          type: string
          title: Hos Ruleset Name
          description: Human-readable ruleset rule label (display; not for joins).
        jurisdiction_type:
          type: string
          title: Jurisdiction Type
          description: >-
            Scope of authority for the rule (US: Interstate/Intrastate; CA:
            Federal/Provincial).
        issue_authority:
          type: string
          title: Issue Authority
          description: >-
            Regulator/authority issuing the rule (e.g., FMCSA, Transport Canada,
            TX DOT).
        region:
          type: string
          title: Region
          description: >-
            Friendly region label (e.g., US Interstate, US Texas Intrastate,
            Canada Federal).
        region_code:
          type: string
          title: Region Code
          description: ISO code for geography (ISO-3166), e.g., US, US-TX, CA, CA-AB.
        cycle_days:
          anyOf:
            - type: integer
            - type: 'null'
          title: Cycle Days
          description: Length of the cycle window (days) (e.g., 7, 8, 14).
        max_cycle_hours:
          anyOf:
            - type: integer
            - type: 'null'
          title: Max Cycle Hours
          description: Maximum on-duty hours allowed per cycle (hours).
        max_drive_hours_per_day:
          anyOf:
            - type: integer
            - type: 'null'
          title: Max Drive Hours Per Day
          description: >-
            Maximum driving hours allowed per local day/24-hour window (hours;
            e.g., US 11, CA 13, null if unknown/NA).
        max_work_hours_per_day:
          anyOf:
            - type: integer
            - type: 'null'
          title: Max Work Hours Per Day
          description: >-
            Maximum on-duty (work) hours per local day, including driving and
            on-duty not driving (hours; e.g., US 14, CA often 16).
        min_offduty_per_day:
          anyOf:
            - type: integer
            - type: 'null'
          title: Min Offduty Per Day
          description: >-
            Minimum off-duty time required per local day (hours); may be
            satisfied via sleeper-berth split per rule.
        is_break_required:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Break Required
          description: >-
            Whether a mid-shift break is mandated by the rule (e.g., US
            30-minute break).
        break_interval_hours:
          anyOf:
            - type: integer
            - type: 'null'
          title: Break Interval Hours
          description: >-
            Hours after which a required break must occur (e.g., 8); null if not
            required.
        is_restart_allowed:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Restart Allowed
          description: Whether a cycle restart/reset is permitted.
        restart_hours:
          anyOf:
            - type: integer
            - type: 'null'
          title: Restart Hours
          description: >-
            Minimum continuous off-duty hours required to restart the cycle
            (hours; e.g., 34, 36, 72, null if restart not allowed).
        restart_frequency_days:
          anyOf:
            - type: integer
            - type: 'null'
          title: Restart Frequency Days
          description: >-
            Minimum days between allowed restarts, if restricted (days; e.g.,
            7).
        is_sleeper_split_allowed:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Sleeper Split Allowed
          description: Whether sleeper-berth split is permitted under this rule.
        sleeper_split_notes:
          anyOf:
            - type: string
            - type: 'null'
          title: Sleeper Split Notes
          description: >-
            Valid sleeper-berth split combinations (free text, e.g., '7+3 or
            8+2', '4+6').
        is_team_rules:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Team Rules
          description: >-
            Indicates a team-driver-specific cycle variant (e.g., Canada Team
            cycles).
        is_big_day_allowed:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Big Day Allowed
          description: Whether a 16-hour short-haul 'big day' is permitted.
        is_short_haul_exemption:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Short Haul Exemption
          description: >-
            Indicates short-haul exemption mode (modifies break/duty windows and
            logging).
        short_haul_airmiles:
          anyOf:
            - type: integer
            - type: 'null'
          title: Short Haul Airmiles
          description: >-
            Short-haul radius limit (air miles; store miles; convert from km as
            needed).
        short_haul_max_duty_hours:
          anyOf:
            - type: integer
            - type: 'null'
          title: Short Haul Max Duty Hours
          description: >-
            Maximum duty hours when operating under short-haul exemptions
            (hours; e.g., 12, 14, 16).
        is_passenger:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Passenger
          description: Passenger-carrier variant; daily drive/work limits may differ.
        is_railroad_exemption:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Railroad Exemption
          description: Railroad emergency exemption applies.
        is_oilfield:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Oilfield
          description: Oilfield/energy sector variant (e.g., waiting-time provisions).
        is_farm_product:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Farm Product
          description: Farm/agricultural product variant (e.g., California farm products).
        is_flammable:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Flammable
          description: Flammable liquids variant (e.g., California hazmat/flammable).
        is_school_pupil:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is School Pupil
          description: >-
            School pupil transportation variant (e.g., California school bus
            rules).
        is_seasonal_exemption:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Seasonal Exemption
          description: >-
            Seasonal or time-bound exemption (e.g., Saskatchewan fertilizer
            exemption).
        is_special_exemption:
          anyOf:
            - type: string
            - type: 'null'
          title: Is Special Exemption
          description: >-
            Free-text description of a special or carrier-specific
            exemption/waiver (e.g., Salesperson, carrier-specific waiver).
      type: object
      required:
        - hos_ruleset_code
        - hos_ruleset_name
        - jurisdiction_type
        - issue_authority
        - region
        - region_code
      title: RefHosRuleset
      description: >-
        Canonical reference table of Hours-of-Service (HOS) Cycle Rulesets for
        North America.


        Each row defines a normalized HOS Cycle Ruleset, its
        jurisdiction/authority, and operational

        characteristics (breaks, restarts, sleeper split, short-haul,
        exemptions, etc.).
    ValidationErrorDetail:
      properties:
        path:
          type: string
          title: Path
        input:
          type: string
          title: Input
        message:
          type: string
          title: Message
        error_type:
          type: string
          title: Error Type
      type: object
      required:
        - path
        - input
        - message
        - error_type
      title: ValidationErrorDetail
    RetryAfterDetail:
      properties:
        retry_after_seconds:
          type: integer
          title: Retry After Seconds
        message:
          type: string
          title: Message
      type: object
      required:
        - retry_after_seconds
        - message
      title: RetryAfterDetail
  securitySchemes:
    Bearer:
      type: oauth2
      flows:
        clientCredentials:
          refreshUrl: >-
            https://auth.catenatelematics.com/realms/catena/protocol/openid-connect/token
          scopes: {}
          tokenUrl: >-
            https://auth.catenatelematics.com/realms/catena/protocol/openid-connect/token
        authorizationCode:
          refreshUrl: >-
            https://auth.catenatelematics.com/realms/catena/protocol/openid-connect/token
          scopes: {}
          authorizationUrl: >-
            https://auth.catenatelematics.com/realms/catena/protocol/openid-connect/auth
          tokenUrl: >-
            https://auth.catenatelematics.com/realms/catena/protocol/openid-connect/token

````