> ## Documentation Index > Fetch the complete documentation index at: https://docs.oncanary.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a work order > Retrieve a single work order by ID ## OpenAPI ````yaml /openapi.yaml get /work-orders/{id} openapi: 3.1.0 info: title: Canary API version: '1.0' description: > Build integrations around Canary work orders, requests, equipment, inventory, meters, custom fields, and scannable identifiers. ## Authentication All API requests require authentication using an API key. Include your API key in the `Authorization` header: ``` Authorization: Bearer sk_live_your_api_key_here ``` ## Rate Limits - **Live keys**: 1,000 requests per minute - **Test keys**: 100 requests per minute Both key prefixes access the same organization data. The prefix selects the rate-limit bucket. Successful authenticated responses include rate limit headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Requests remaining in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Pagination Canary-native list endpoints use ID cursors and the standard `data`/`meta` envelope. MaintainX-compatible request endpoints use their compatibility response wrappers and encoded offset cursors. Follow each operation's response schema. Native list responses include: - `data`: Array of items - `meta.pagination.cursor`: Cursor for the next page (if `has_more` is true) - `meta.pagination.has_more`: Whether more items exist Use the cursor value in your next request: `?cursor=` servers: - url: https://api.oncanary.com/v1 description: Production - url: http://localhost:3000/api/v1 description: Local Development security: - bearerAuth: [] tags: - name: Meters description: Meters track equipment usage and readings - name: Meter Readings description: Record and retrieve meter readings - name: Work Orders description: Maintenance work orders - name: Work Requests description: Requests that can be reviewed and converted into work orders - name: Work Request Portals description: Public request portal configuration - name: Assets description: Equipment and machinery - name: Locations description: Physical places where assets, parts, and meters are assigned - name: Parts description: Spare parts and inventory records - name: Identifiers description: Scannable identifiers for assets, locations, and parts - name: Custom Fields description: Typed custom-field definitions shared by maintenance resources paths: /work-orders/{id}: get: tags: - Work Orders summary: Get a work order description: Retrieve a single work order by ID operationId: getWorkOrder parameters: - $ref: '#/components/parameters/id' responses: '200': description: Work order details content: application/json: schema: $ref: '#/components/schemas/WorkOrderResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' components: parameters: id: name: id in: path required: true description: Resource ID schema: type: string schemas: WorkOrderResponse: allOf: - $ref: '#/components/schemas/SingleResponse' - type: object properties: data: $ref: '#/components/schemas/WorkOrder' SingleResponse: type: object required: - data - meta properties: data: type: object meta: type: object required: - request_id - api_version properties: request_id: type: string api_version: type: string WorkOrder: type: object required: - id - title - description - type - status - priority - requested_by - creator_id - assigned_to_user_id - assigned_to_team_id - asset_id - location_id - due_date - scheduled_start - estimated_hours - recurrence_info - previous_id - next_id - completed_at - completer_id - completion_summary - inventory_reconciliation_required - image_url - created_at - updated_at properties: id: type: string title: type: string description: type: - string - 'null' type: anyOf: - $ref: '#/components/schemas/WorkOrderType' - type: 'null' status: $ref: '#/components/schemas/WorkOrderStatus' priority: $ref: '#/components/schemas/WorkOrderPriority' requested_by: type: - string - 'null' creator_id: type: - string - 'null' readOnly: true description: >- Immutable authenticated creator when the work order originated from a human app context assigned_to_user_id: type: - string - 'null' assigned_to_team_id: type: - string - 'null' asset_id: type: - string - 'null' location_id: type: - string - 'null' due_date: type: - string - 'null' format: date-time scheduled_start: type: - string - 'null' format: date-time estimated_hours: type: - number - 'null' format: double minimum: 0 maximum: 9999.99 recurrence_info: anyOf: - $ref: '#/components/schemas/WorkOrderRecurrenceInfo' - type: 'null' readOnly: true previous_id: type: - string - 'null' readOnly: true next_id: type: - string - 'null' readOnly: true completed_at: type: - string - 'null' format: date-time readOnly: true completer_id: type: - string - 'null' readOnly: true completion_summary: type: - string - 'null' maxLength: 5000 inventory_reconciliation_required: type: boolean readOnly: true description: >- True when completion occurred while Parts was disabled and inventory must be reconciled explicitly extraFields: $ref: '#/components/schemas/ExtraFields' image_url: type: - string - 'null' created_at: type: string format: date-time updated_at: type: string format: date-time ProblemDetails: type: object description: RFC 7807 Problem Details required: - type - title - status - detail - request_id - code example: type: https://api.oncanary.com/errors/validation_error title: Validation Error status: 400 detail: Request validation failed request_id: req_01JAY8FVDM6CH4R3X9Q2T7K5NP code: validation_error properties: type: type: string format: uri title: type: string status: type: integer detail: type: string request_id: type: string code: type: string validation_errors: type: array items: type: object required: - field - message properties: field: type: string message: type: string WorkOrderType: type: string enum: - preventive - reactive - other - cycle_count WorkOrderStatus: type: string enum: - open - on_hold - in_progress - done - canceled - skipped WorkOrderPriority: type: string enum: - low - medium - high - critical WorkOrderRecurrenceInfo: type: object required: - type readOnly: true properties: type: type: string enum: - DAILY - WEEKLY - MONTHLY - YEARLY - PERIODICALLY interval: type: integer minimum: 0 days: type: array items: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY day: type: integer minimum: 1 maximum: 31 ExtraFields: type: object description: >- Label-keyed custom-field values. Omitted labels remain unchanged on update. additionalProperties: type: string maxLength: 4096 responses: Unauthorized: description: Unauthorized - Invalid or missing API key headers: X-Request-ID: $ref: '#/components/headers/RequestId' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' Forbidden: description: >- Forbidden - `insufficient_scope` when the API key lacks the scope, or `module_disabled` when the organization module is disabled headers: X-Request-ID: $ref: '#/components/headers/RequestId' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' NotFound: description: Resource not found headers: X-Request-ID: $ref: '#/components/headers/RequestId' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' RateLimited: description: Rate limit exceeded headers: X-Request-ID: $ref: '#/components/headers/RequestId' Retry-After: description: Seconds until rate limit resets schema: type: integer content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' headers: RequestId: description: Unique request identifier to include with support requests schema: type: string example: req_01JAY8FVDM6CH4R3X9Q2T7K5NP securitySchemes: bearerAuth: type: http scheme: bearer description: Organization API key with an `sk_live_` or `sk_test_` prefix ````