---
updatedAt: 2026-05-28T19:21:19.000Z
agentTools:
  projectIndex: https://developers.remberg.de/llms.txt
---

# Get a Work Order by its internal ID

Returns a single Work Order identified by its internal ID, including all its properties and optional populated references.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/v2/work-orders/{id}": {
      "get": {
        "description": "Returns a single Work Order identified by its internal ID, including all its properties and optional populated references.",
        "operationId": "/v2/work-orders/{id}_get",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "description": "The Work Order's internal ID",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "associations",
            "required": false,
            "in": "query",
            "description": "Define which associations should be included in the response.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "relatedOrganization",
                  "relatedAssets",
                  "customProperties",
                  "responsibleGroup",
                  "assignedGroups"
                ]
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Work Order retrieved",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkOrderCfaResponseDto"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          }
        },
        "security": [
          {
            "authorization": []
          }
        ],
        "summary": "Get a Work Order by its internal ID",
        "tags": [
          "work-orders"
        ],
        "x-controller-class": "WorkOrdersCfaController"
      }
    }
  },
  "info": {
    "title": "Work Orders",
    "description": "The remberg work order API description",
    "version": "v2",
    "contact": {}
  },
  "servers": [
    {
      "url": "https://api.remberg.de"
    }
  ],
  "components": {
    "securitySchemes": {
      "authorization": {
        "type": "apiKey",
        "in": "header",
        "name": "authorization"
      }
    },
    "schemas": {
      "ContactInfoCfaResponseDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "firstName": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "email": {
            "type": "string"
          }
        },
        "required": [
          "id"
        ]
      },
      "AddressCfaResponseDto": {
        "type": "object",
        "properties": {
          "company": {
            "type": "string",
            "description": "The name of the company or organization associated with the address."
          },
          "street": {
            "type": "string",
            "description": "The name of the street for the address."
          },
          "streetNumber": {
            "type": "string",
            "description": "The specific number or identifier for the location on the street."
          },
          "zipPostCode": {
            "type": "string",
            "description": "The postal or ZIP code for the address."
          },
          "city": {
            "type": "string",
            "description": "The name of the city where the address is located."
          },
          "countryProvince": {
            "type": "string",
            "description": "The province or state within the country of the address."
          },
          "country": {
            "type": "string",
            "description": "The name of the country for the address."
          },
          "other": {
            "type": "string",
            "description": "Additional details or descriptions related to the address."
          }
        }
      },
      "OrganizationInfoCfaResponseDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "organizationName": {
            "type": "string"
          },
          "organizationNumber": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "organizationName"
        ]
      },
      "AssetInfoCfaResponseDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "assetNumber": {
            "type": "string"
          },
          "assetType": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "assetNumber",
          "assetType"
        ]
      },
      "CustomPropertyValueCfaResponseDto": {
        "type": "object",
        "properties": {
          "reference": {
            "type": "string",
            "description": "The reference of the custom property the value is assigned to"
          },
          "value": {
            "type": "object",
            "description": "The value of the custom property"
          },
          "associationValue": {
            "description": "The populated related object value if \"customProperties\" is present in \"associations\" query",
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/AssetInfoCfaResponseDto"
                },
                {
                  "$ref": "#/components/schemas/ContactInfoCfaResponseDto"
                },
                {
                  "$ref": "#/components/schemas/OrganizationInfoCfaResponseDto"
                }
              ]
            }
          }
        },
        "required": [
          "reference",
          "value"
        ]
      },
      "UserGroupInfoCfaResponseDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "A remberg internal unique identifier for the user group."
          },
          "name": {
            "type": "string",
            "description": "The name of the user group."
          }
        },
        "required": [
          "id",
          "name"
        ]
      },
      "WorkOrderProcedureValueCfaResponseDto": {
        "type": "object",
        "properties": {
          "instanceId": {
            "type": "string",
            "description": "The procedure's instance ID"
          },
          "templateId": {
            "type": "string",
            "description": "The procedure's template ID"
          },
          "type": {
            "type": "string",
            "enum": [
              "safetyCheck",
              "maintenance",
              "asset",
              "findingsAndActions",
              "validation"
            ],
            "description": "The procedure's type"
          },
          "status": {
            "type": "string",
            "enum": [
              "open",
              "inProgress",
              "completed"
            ],
            "description": "The procedure's status"
          },
          "totalFields": {
            "type": "number",
            "description": "The procedure's total number of fields"
          },
          "completedFields": {
            "type": "number",
            "description": "The procedure's number of completed fields"
          },
          "failedFields": {
            "type": "number",
            "description": "The procedure's number of failed fields"
          }
        },
        "required": [
          "instanceId",
          "type",
          "status",
          "totalFields",
          "completedFields",
          "failedFields"
        ]
      },
      "WorkOrderCfaResponseDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The work order's internal ID"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "The work order's creation date"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "The work order's date of the last update as an ISO UTC string",
            "example": "2025-01-15T10:00:00.000Z"
          },
          "counter": {
            "type": "string",
            "description": "The work order's counter"
          },
          "createdByType": {
            "type": "string",
            "enum": [
              "user",
              "apiKey",
              "system",
              "maintenancePlan",
              "userViaWorkRequest",
              "other"
            ],
            "description": "Indicates how the work order was created",
            "example": "userViaWorkRequest"
          },
          "subject": {
            "type": "string",
            "description": "The work order's subject"
          },
          "description": {
            "type": "string",
            "description": "The work order's description"
          },
          "startDate": {
            "type": "string",
            "format": "date-time",
            "description": "The work order's planning start date as an ISO UTC string",
            "example": "2025-01-15T10:00:00.000Z"
          },
          "endDate": {
            "type": "string",
            "format": "date-time",
            "description": "The work order's planning end date as an ISO UTC string",
            "example": "2025-01-15T10:00:00.000Z"
          },
          "dueDate": {
            "type": "string",
            "format": "date",
            "description": "The work order's due date as an ISO 8601 string",
            "example": "2025-01-15"
          },
          "parentWorkOrderId": {
            "type": "string",
            "description": "The work order's parent work order internal ID"
          },
          "location": {
            "description": "The work order's location",
            "allOf": [
              {
                "$ref": "#/components/schemas/AddressCfaResponseDto"
              }
            ]
          },
          "priority": {
            "type": "string",
            "enum": [
              "000_low",
              "010_normal",
              "020_high",
              "030_critical"
            ],
            "description": "The work order's priority"
          },
          "externalReference": {
            "type": "string",
            "description": "The work order's external reference"
          },
          "relatedOrganizationId": {
            "type": "string",
            "description": "The asset's manufacturer organization internal ID"
          },
          "relatedOrganization": {
            "description": "The asset's manufacturer organization (only if relatedOrganization is included in associations)",
            "allOf": [
              {
                "$ref": "#/components/schemas/OrganizationInfoCfaResponseDto"
              }
            ]
          },
          "relatedAssetIds": {
            "description": "The work order's related asset internal IDs",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "relatedAssets": {
            "description": "The work order's related assets (only if relatedAssets is included in associations)",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AssetInfoCfaResponseDto"
            }
          },
          "relatedTicketId": {
            "type": "string",
            "description": "The work order's related ticket internal ID"
          },
          "relatedCaseId": {
            "type": "string",
            "description": "This field is deprecated, use relatedTicketId instead. The work order's related ticket internal ID."
          },
          "typeReference": {
            "type": "string",
            "description": "The work order's type reference"
          },
          "statusReference": {
            "type": "string",
            "description": "The work order's status reference"
          },
          "customPropertyValues": {
            "description": "The work order's custom properties",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomPropertyValueCfaResponseDto"
            }
          },
          "assignedContactIds": {
            "description": "The work order's performing contact internal IDs",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "assignedGroupIds": {
            "description": "The work order's performing group internal IDs",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "assignedGroups": {
            "description": "The work order's performing groups (only if assignedGroups is included in associations)",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UserGroupInfoCfaResponseDto"
            }
          },
          "responsibleGroupId": {
            "type": "string",
            "description": "The work order's responsible group internal ID"
          },
          "responsibleGroup": {
            "description": "The work order's responsible group (only if responsibleGroup is included in associations)",
            "allOf": [
              {
                "$ref": "#/components/schemas/UserGroupInfoCfaResponseDto"
              }
            ]
          },
          "responsibleContactId": {
            "type": "string",
            "description": "The work order's responsible contact internal ID"
          },
          "totalDurationInSeconds": {
            "type": "number",
            "description": "The work order's total duration in seconds"
          },
          "estimatedDurationInSeconds": {
            "type": "number",
            "description": "The work order's estimated duration in seconds"
          },
          "procedureValues": {
            "description": "The work order's procedure summaries",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WorkOrderProcedureValueCfaResponseDto"
            }
          }
        },
        "required": [
          "id",
          "createdAt",
          "updatedAt",
          "counter",
          "createdByType",
          "subject",
          "statusReference",
          "customPropertyValues",
          "assignedContactIds",
          "assignedGroupIds"
        ]
      }
    }
  }
}
```