--- title: "Get a maintenance program" method: GET path: "/assets/v1/maintenance/program" tags: ["Assets"] --- # Get a maintenance program `GET /assets/v1/maintenance/program` ## Query parameters - `id` string ## Response `200` A successful response. - S12AssetsV1GetProgramResponse — Result returned from `GetProgram` - `program` S12AssetsV1MaintenanceProgram - `id` string — The identifier of the maintenance program. - `name` string — The name of the maintenance program. - `description` string — Description and extra information for a maintenance program - `plans` S12AssetsV1MaintenancePlan[] — The plans associated with the program - `id` string — The identifier of the maintenance plan. - `name` string — The name of the maintenance plan. - `intervals` S12AssetsV1MaintenanceInterval[] — The interval of the maintenance plan. - `interval` S12AssetsV1MaintenanceMetricValue - `unit_value` S12AssetsV1UnitValue — The unit value represents a measurement value with a unit symbol. It is used to represent a value with a unit symbol, such as 10 km or 5 hours. - `value` number, double - `unit` 'MEASUREMENT_UNIT_SYMBOL_KILOMETERS' | 'MEASUREMENT_UNIT_SYMBOL_MILES' | 'MEASUREMENT_UNIT_SYMBOL_HOURS' | 'MEASUREMENT_UNIT_SYMBOL_MINUTES' | 'MEASUREMENT_UNIT_SYMBOL_INCHES' | 'MEASUREMENT_UNIT_SYMBOL_FOOT' | 'MEASUREMENT_UNIT_SYMBOL_MILLIMETERS' | 'MEASUREMENT_UNIT_SYMBOL_CENTIMETERS' | 'MEASUREMENT_UNIT_SYMBOL_METERS' | 'MEASUREMENT_UNIT_SYMBOL_MILLILITRES' | 'MEASUREMENT_UNIT_SYMBOL_LITRES' | 'MEASUREMENT_UNIT_SYMBOL_GALLONS' | 'MEASUREMENT_UNIT_SYMBOL_CUBIC_METERS' | 'MEASUREMENT_UNIT_SYMBOL_SECONDS' | 'MEASUREMENT_UNIT_SYMBOL_FAHRENHEIT' | 'MEASUREMENT_UNIT_SYMBOL_CELSIUS' | 'MEASUREMENT_UNIT_SYMBOL_KELVIN' | 'MEASUREMENT_UNIT_SYMBOL_OUNCE' | 'MEASUREMENT_UNIT_SYMBOL_POUNDS' | 'MEASUREMENT_UNIT_SYMBOL_TONNES' | 'MEASUREMENT_UNIT_SYMBOL_GRAMS' | 'MEASUREMENT_UNIT_SYMBOL_KILOGRAMS' | 'MEASUREMENT_UNIT_SYMBOL_AMPERES' | 'MEASUREMENT_UNIT_SYMBOL_HERTZ' | 'MEASUREMENT_UNIT_SYMBOL_OHM' | 'MEASUREMENT_UNIT_SYMBOL_VOLTS' | 'MEASUREMENT_UNIT_SYMBOL_WATTS' | 'MEASUREMENT_UNIT_SYMBOL_CANDELA' | 'MEASUREMENT_UNIT_SYMBOL_CYCLES' | 'MEASUREMENT_UNIT_SYMBOL_PERCENT' | 'MEASUREMENT_UNIT_SYMBOL_POUNDS_PER_SQUARE_INCH' | 'MEASUREMENT_UNIT_SYMBOL_MOLE' | 'MEASUREMENT_UNIT_SYMBOL_DAYS' | 'MEASUREMENT_UNIT_SYMBOL_WEEKS' | 'MEASUREMENT_UNIT_SYMBOL_MONTHS' — Collection of symbols (km, mi, hr, etc) used in units of measurement. - MEASUREMENT_UNIT_SYMBOL_KILOMETERS: Measurement unit symbol for kilometers. - MEASUREMENT_UNIT_SYMBOL_MILES: Measurement unit symbol for miles. - MEASUREMENT_UNIT_SYMBOL_HOURS: Measurement unit symbol for hours. - MEASUREMENT_UNIT_SYMBOL_MINUTES: Measurement unit symbol for minutes. - MEASUREMENT_UNIT_SYMBOL_INCHES: Measurement unit symbol for inches. - MEASUREMENT_UNIT_SYMBOL_FOOT: Measurement unit symbol for foot. - MEASUREMENT_UNIT_SYMBOL_MILLIMETERS: Measurement unit symbol for Millimeters. - MEASUREMENT_UNIT_SYMBOL_CENTIMETERS: Measurement unit symbol for Centimeters. - MEASUREMENT_UNIT_SYMBOL_METERS: Measurement unit symbol for meters. - MEASUREMENT_UNIT_SYMBOL_MILLILITRES: Measurement unit symbol for millilitres. - MEASUREMENT_UNIT_SYMBOL_LITRES: Measurement unit symbol for litres. - MEASUREMENT_UNIT_SYMBOL_GALLONS: Measurement unit symbol for gallons. - MEASUREMENT_UNIT_SYMBOL_CUBIC_METERS: Measurement unit symbol for cubic meters. - MEASUREMENT_UNIT_SYMBOL_SECONDS: Measurement unit symbol for seconds. - MEASUREMENT_UNIT_SYMBOL_FAHRENHEIT: Measurement unit symbol for fahrenheit. - MEASUREMENT_UNIT_SYMBOL_CELSIUS: Measurement unit symbol for celsius. - MEASUREMENT_UNIT_SYMBOL_KELVIN: Measurement unit symbol for kelvin. - MEASUREMENT_UNIT_SYMBOL_OUNCE: Measurement unit symbol for ounce. - MEASUREMENT_UNIT_SYMBOL_POUNDS: Measurement unit symbol for pounds. - MEASUREMENT_UNIT_SYMBOL_TONNES: Measurement unit symbol for tonnes. - MEASUREMENT_UNIT_SYMBOL_GRAMS: Measurement unit symbol for grams. - MEASUREMENT_UNIT_SYMBOL_KILOGRAMS: Measurement unit symbol for kilograms. - MEASUREMENT_UNIT_SYMBOL_AMPERES: Measurement unit symbol for amperes. - MEASUREMENT_UNIT_SYMBOL_HERTZ: Measurement unit symbol for hertz. - MEASUREMENT_UNIT_SYMBOL_OHM: Measurement unit symbol for ohm. - MEASUREMENT_UNIT_SYMBOL_VOLTS: Measurement unit symbol for volts. - MEASUREMENT_UNIT_SYMBOL_WATTS: Measurement unit symbol for watts. - MEASUREMENT_UNIT_SYMBOL_CANDELA: Measurement unit symbol for candela. - MEASUREMENT_UNIT_SYMBOL_CYCLES: Measurement unit symbol for cycles. - MEASUREMENT_UNIT_SYMBOL_PERCENT: Measurement unit symbol for percent. - MEASUREMENT_UNIT_SYMBOL_POUNDS_PER_SQUARE_INCH: Measurement unit symbol for pounds per square inch. - MEASUREMENT_UNIT_SYMBOL_MOLE: Measurement unit symbol for mole. - MEASUREMENT_UNIT_SYMBOL_DAYS: Measurement unit symbol for days. - MEASUREMENT_UNIT_SYMBOL_WEEKS: Measurement unit symbol for weeks. - MEASUREMENT_UNIT_SYMBOL_MONTHS: Measurement unit symbol for months. - `timestamp` string, date-time - `is_recurring` boolean — Defines if interval is recurring (e.g. every 10000km if repeating or at 10000km if not) - `due_soon` S12AssetsV1MaintenanceMetricValue - `unit_value` S12AssetsV1UnitValue — The unit value represents a measurement value with a unit symbol. It is used to represent a value with a unit symbol, such as 10 km or 5 hours. - `value` number, double - `unit` 'MEASUREMENT_UNIT_SYMBOL_KILOMETERS' | 'MEASUREMENT_UNIT_SYMBOL_MILES' | 'MEASUREMENT_UNIT_SYMBOL_HOURS' | 'MEASUREMENT_UNIT_SYMBOL_MINUTES' | 'MEASUREMENT_UNIT_SYMBOL_INCHES' | 'MEASUREMENT_UNIT_SYMBOL_FOOT' | 'MEASUREMENT_UNIT_SYMBOL_MILLIMETERS' | 'MEASUREMENT_UNIT_SYMBOL_CENTIMETERS' | 'MEASUREMENT_UNIT_SYMBOL_METERS' | 'MEASUREMENT_UNIT_SYMBOL_MILLILITRES' | 'MEASUREMENT_UNIT_SYMBOL_LITRES' | 'MEASUREMENT_UNIT_SYMBOL_GALLONS' | 'MEASUREMENT_UNIT_SYMBOL_CUBIC_METERS' | 'MEASUREMENT_UNIT_SYMBOL_SECONDS' | 'MEASUREMENT_UNIT_SYMBOL_FAHRENHEIT' | 'MEASUREMENT_UNIT_SYMBOL_CELSIUS' | 'MEASUREMENT_UNIT_SYMBOL_KELVIN' | 'MEASUREMENT_UNIT_SYMBOL_OUNCE' | 'MEASUREMENT_UNIT_SYMBOL_POUNDS' | 'MEASUREMENT_UNIT_SYMBOL_TONNES' | 'MEASUREMENT_UNIT_SYMBOL_GRAMS' | 'MEASUREMENT_UNIT_SYMBOL_KILOGRAMS' | 'MEASUREMENT_UNIT_SYMBOL_AMPERES' | 'MEASUREMENT_UNIT_SYMBOL_HERTZ' | 'MEASUREMENT_UNIT_SYMBOL_OHM' | 'MEASUREMENT_UNIT_SYMBOL_VOLTS' | 'MEASUREMENT_UNIT_SYMBOL_WATTS' | 'MEASUREMENT_UNIT_SYMBOL_CANDELA' | 'MEASUREMENT_UNIT_SYMBOL_CYCLES' | 'MEASUREMENT_UNIT_SYMBOL_PERCENT' | 'MEASUREMENT_UNIT_SYMBOL_POUNDS_PER_SQUARE_INCH' | 'MEASUREMENT_UNIT_SYMBOL_MOLE' | 'MEASUREMENT_UNIT_SYMBOL_DAYS' | 'MEASUREMENT_UNIT_SYMBOL_WEEKS' | 'MEASUREMENT_UNIT_SYMBOL_MONTHS' — Collection of symbols (km, mi, hr, etc) used in units of measurement. - MEASUREMENT_UNIT_SYMBOL_KILOMETERS: Measurement unit symbol for kilometers. - MEASUREMENT_UNIT_SYMBOL_MILES: Measurement unit symbol for miles. - MEASUREMENT_UNIT_SYMBOL_HOURS: Measurement unit symbol for hours. - MEASUREMENT_UNIT_SYMBOL_MINUTES: Measurement unit symbol for minutes. - MEASUREMENT_UNIT_SYMBOL_INCHES: Measurement unit symbol for inches. - MEASUREMENT_UNIT_SYMBOL_FOOT: Measurement unit symbol for foot. - MEASUREMENT_UNIT_SYMBOL_MILLIMETERS: Measurement unit symbol for Millimeters. - MEASUREMENT_UNIT_SYMBOL_CENTIMETERS: Measurement unit symbol for Centimeters. - MEASUREMENT_UNIT_SYMBOL_METERS: Measurement unit symbol for meters. - MEASUREMENT_UNIT_SYMBOL_MILLILITRES: Measurement unit symbol for millilitres. - MEASUREMENT_UNIT_SYMBOL_LITRES: Measurement unit symbol for litres. - MEASUREMENT_UNIT_SYMBOL_GALLONS: Measurement unit symbol for gallons. - MEASUREMENT_UNIT_SYMBOL_CUBIC_METERS: Measurement unit symbol for cubic meters. - MEASUREMENT_UNIT_SYMBOL_SECONDS: Measurement unit symbol for seconds. - MEASUREMENT_UNIT_SYMBOL_FAHRENHEIT: Measurement unit symbol for fahrenheit. - MEASUREMENT_UNIT_SYMBOL_CELSIUS: Measurement unit symbol for celsius. - MEASUREMENT_UNIT_SYMBOL_KELVIN: Measurement unit symbol for kelvin. - MEASUREMENT_UNIT_SYMBOL_OUNCE: Measurement unit symbol for ounce. - MEASUREMENT_UNIT_SYMBOL_POUNDS: Measurement unit symbol for pounds. - MEASUREMENT_UNIT_SYMBOL_TONNES: Measurement unit symbol for tonnes. - MEASUREMENT_UNIT_SYMBOL_GRAMS: Measurement unit symbol for grams. - MEASUREMENT_UNIT_SYMBOL_KILOGRAMS: Measurement unit symbol for kilograms. - MEASUREMENT_UNIT_SYMBOL_AMPERES: Measurement unit symbol for amperes. - MEASUREMENT_UNIT_SYMBOL_HERTZ: Measurement unit symbol for hertz. - MEASUREMENT_UNIT_SYMBOL_OHM: Measurement unit symbol for ohm. - MEASUREMENT_UNIT_SYMBOL_VOLTS: Measurement unit symbol for volts. - MEASUREMENT_UNIT_SYMBOL_WATTS: Measurement unit symbol for watts. - MEASUREMENT_UNIT_SYMBOL_CANDELA: Measurement unit symbol for candela. - MEASUREMENT_UNIT_SYMBOL_CYCLES: Measurement unit symbol for cycles. - MEASUREMENT_UNIT_SYMBOL_PERCENT: Measurement unit symbol for percent. - MEASUREMENT_UNIT_SYMBOL_POUNDS_PER_SQUARE_INCH: Measurement unit symbol for pounds per square inch. - MEASUREMENT_UNIT_SYMBOL_MOLE: Measurement unit symbol for mole. - MEASUREMENT_UNIT_SYMBOL_DAYS: Measurement unit symbol for days. - MEASUREMENT_UNIT_SYMBOL_WEEKS: Measurement unit symbol for weeks. - MEASUREMENT_UNIT_SYMBOL_MONTHS: Measurement unit symbol for months. - `timestamp` string, date-time - `type` 'MAINTENANCE_INTERVAL_TYPE_UNSPECIFIED' | 'MAINTENANCE_INTERVAL_TYPE_ODOMETER' | 'MAINTENANCE_INTERVAL_TYPE_RUNTIME' | 'MAINTENANCE_INTERVAL_TYPE_TIME' — MaintenanceIntervalType represents the type of maintenance interval. - MAINTENANCE_INTERVAL_TYPE_UNSPECIFIED: MAINTENANCE_INTERVAL_TYPE_UNSPECIFIED is an unknown maintenance interval type. - MAINTENANCE_INTERVAL_TYPE_ODOMETER: MAINTENANCE_INTERVAL_TYPE_ODOMETER is a maintenance interval type that is odometer based. - MAINTENANCE_INTERVAL_TYPE_RUNTIME: MAINTENANCE_INTERVAL_TYPE_RUNTIME is a maintenance interval type that is runtime based. - MAINTENANCE_INTERVAL_TYPE_TIME: MAINTENANCE_INTERVAL_TYPE_TIME is a maintenance interval type that is time based. - `description` string — Description and extra information for a maintenance plan - `update_status` 'MAINTENANCE_PLAN_UPDATE_STATUS_UNSPECIFIED' | 'MAINTENANCE_PLAN_UPDATE_STATUS_IN_PROGRESS' | 'MAINTENANCE_PLAN_UPDATE_STATUS_COMPLETED' | 'MAINTENANCE_PLAN_UPDATE_STATUS_FAILED' — MaintenancePlanUpdateStatus represents the status of a maintenance plan update operation. - MAINTENANCE_PLAN_UPDATE_STATUS_UNSPECIFIED: MAINTENANCE_PLAN_UPDATE_STATUS_UNSPECIFIED is an unknown maintenance plan update status. - MAINTENANCE_PLAN_UPDATE_STATUS_IN_PROGRESS: MAINTENANCE_PLAN_UPDATE_STATUS_IN_PROGRESS indicates a plan update is currently in progress. - MAINTENANCE_PLAN_UPDATE_STATUS_COMPLETED: MAINTENANCE_PLAN_UPDATE_STATUS_COMPLETED indicates a plan update has been completed successfully. - MAINTENANCE_PLAN_UPDATE_STATUS_FAILED: MAINTENANCE_PLAN_UPDATE_STATUS_FAILED indicates a plan update has failed. - `triggers` S12AssetsV1MaintenanceTrigger[] — The list of maintenance triggers of a plan. - `id` string — The identifier of the maintenance trigger. - `created_at` string, date-time — Time when maintenance trigger was created. - `modified_at` string, date-time — Time when maintenance trigger was last modified. - `notification` S12AssetsV1MaintenanceTriggerNotification — The notification maintenance trigger. - `user_ids` string[] — A list of user IDs that will receive the notification. - `group_ids` string[] — A list of group IDs that will receive the notification. - `before` S12AssetsV1MaintenanceMetricValue - `unit_value` S12AssetsV1UnitValue — The unit value represents a measurement value with a unit symbol. It is used to represent a value with a unit symbol, such as 10 km or 5 hours. - `value` number, double - `unit` 'MEASUREMENT_UNIT_SYMBOL_KILOMETERS' | 'MEASUREMENT_UNIT_SYMBOL_MILES' | 'MEASUREMENT_UNIT_SYMBOL_HOURS' | 'MEASUREMENT_UNIT_SYMBOL_MINUTES' | 'MEASUREMENT_UNIT_SYMBOL_INCHES' | 'MEASUREMENT_UNIT_SYMBOL_FOOT' | 'MEASUREMENT_UNIT_SYMBOL_MILLIMETERS' | 'MEASUREMENT_UNIT_SYMBOL_CENTIMETERS' | 'MEASUREMENT_UNIT_SYMBOL_METERS' | 'MEASUREMENT_UNIT_SYMBOL_MILLILITRES' | 'MEASUREMENT_UNIT_SYMBOL_LITRES' | 'MEASUREMENT_UNIT_SYMBOL_GALLONS' | 'MEASUREMENT_UNIT_SYMBOL_CUBIC_METERS' | 'MEASUREMENT_UNIT_SYMBOL_SECONDS' | 'MEASUREMENT_UNIT_SYMBOL_FAHRENHEIT' | 'MEASUREMENT_UNIT_SYMBOL_CELSIUS' | 'MEASUREMENT_UNIT_SYMBOL_KELVIN' | 'MEASUREMENT_UNIT_SYMBOL_OUNCE' | 'MEASUREMENT_UNIT_SYMBOL_POUNDS' | 'MEASUREMENT_UNIT_SYMBOL_TONNES' | 'MEASUREMENT_UNIT_SYMBOL_GRAMS' | 'MEASUREMENT_UNIT_SYMBOL_KILOGRAMS' | 'MEASUREMENT_UNIT_SYMBOL_AMPERES' | 'MEASUREMENT_UNIT_SYMBOL_HERTZ' | 'MEASUREMENT_UNIT_SYMBOL_OHM' | 'MEASUREMENT_UNIT_SYMBOL_VOLTS' | 'MEASUREMENT_UNIT_SYMBOL_WATTS' | 'MEASUREMENT_UNIT_SYMBOL_CANDELA' | 'MEASUREMENT_UNIT_SYMBOL_CYCLES' | 'MEASUREMENT_UNIT_SYMBOL_PERCENT' | 'MEASUREMENT_UNIT_SYMBOL_POUNDS_PER_SQUARE_INCH' | 'MEASUREMENT_UNIT_SYMBOL_MOLE' | 'MEASUREMENT_UNIT_SYMBOL_DAYS' | 'MEASUREMENT_UNIT_SYMBOL_WEEKS' | 'MEASUREMENT_UNIT_SYMBOL_MONTHS' — Collection of symbols (km, mi, hr, etc) used in units of measurement. - MEASUREMENT_UNIT_SYMBOL_KILOMETERS: Measurement unit symbol for kilometers. - MEASUREMENT_UNIT_SYMBOL_MILES: Measurement unit symbol for miles. - MEASUREMENT_UNIT_SYMBOL_HOURS: Measurement unit symbol for hours. - MEASUREMENT_UNIT_SYMBOL_MINUTES: Measurement unit symbol for minutes. - MEASUREMENT_UNIT_SYMBOL_INCHES: Measurement unit symbol for inches. - MEASUREMENT_UNIT_SYMBOL_FOOT: Measurement unit symbol for foot. - MEASUREMENT_UNIT_SYMBOL_MILLIMETERS: Measurement unit symbol for Millimeters. - MEASUREMENT_UNIT_SYMBOL_CENTIMETERS: Measurement unit symbol for Centimeters. - MEASUREMENT_UNIT_SYMBOL_METERS: Measurement unit symbol for meters. - MEASUREMENT_UNIT_SYMBOL_MILLILITRES: Measurement unit symbol for millilitres. - MEASUREMENT_UNIT_SYMBOL_LITRES: Measurement unit symbol for litres. - MEASUREMENT_UNIT_SYMBOL_GALLONS: Measurement unit symbol for gallons. - MEASUREMENT_UNIT_SYMBOL_CUBIC_METERS: Measurement unit symbol for cubic meters. - MEASUREMENT_UNIT_SYMBOL_SECONDS: Measurement unit symbol for seconds. - MEASUREMENT_UNIT_SYMBOL_FAHRENHEIT: Measurement unit symbol for fahrenheit. - MEASUREMENT_UNIT_SYMBOL_CELSIUS: Measurement unit symbol for celsius. - MEASUREMENT_UNIT_SYMBOL_KELVIN: Measurement unit symbol for kelvin. - MEASUREMENT_UNIT_SYMBOL_OUNCE: Measurement unit symbol for ounce. - MEASUREMENT_UNIT_SYMBOL_POUNDS: Measurement unit symbol for pounds. - MEASUREMENT_UNIT_SYMBOL_TONNES: Measurement unit symbol for tonnes. - MEASUREMENT_UNIT_SYMBOL_GRAMS: Measurement unit symbol for grams. - MEASUREMENT_UNIT_SYMBOL_KILOGRAMS: Measurement unit symbol for kilograms. - MEASUREMENT_UNIT_SYMBOL_AMPERES: Measurement unit symbol for amperes. - MEASUREMENT_UNIT_SYMBOL_HERTZ: Measurement unit symbol for hertz. - MEASUREMENT_UNIT_SYMBOL_OHM: Measurement unit symbol for ohm. - MEASUREMENT_UNIT_SYMBOL_VOLTS: Measurement unit symbol for volts. - MEASUREMENT_UNIT_SYMBOL_WATTS: Measurement unit symbol for watts. - MEASUREMENT_UNIT_SYMBOL_CANDELA: Measurement unit symbol for candela. - MEASUREMENT_UNIT_SYMBOL_CYCLES: Measurement unit symbol for cycles. - MEASUREMENT_UNIT_SYMBOL_PERCENT: Measurement unit symbol for percent. - MEASUREMENT_UNIT_SYMBOL_POUNDS_PER_SQUARE_INCH: Measurement unit symbol for pounds per square inch. - MEASUREMENT_UNIT_SYMBOL_MOLE: Measurement unit symbol for mole. - MEASUREMENT_UNIT_SYMBOL_DAYS: Measurement unit symbol for days. - MEASUREMENT_UNIT_SYMBOL_WEEKS: Measurement unit symbol for weeks. - MEASUREMENT_UNIT_SYMBOL_MONTHS: Measurement unit symbol for months. - `timestamp` string, date-time ## Other responses - `default` — An unexpected error response. --- [API](https://skmtc.net/safetyculture/apis/safetyculture-api.md) · [All operations](https://skmtc.net/safetyculture/apis/safetyculture-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/safetyculture/safetyculture-api/revisions/5be91df61ded/schema)