Incidents

Get an incident

Returns an incident by its identifier: what broke, what it falls on, which status it is in and whether it blocks the availability of the material.

GET

/api/v1/incidents/{incidentId}

curl https://app.filmo.io/api/v1/incidents/inci_8f2a1c \
  --header "Authorization: Bearer $FILMO_API_KEY"

Node.jsfetch('https://app.filmo.io/api/v1/incidents/inci_8f2a1c', { headers: { Authorization: 'Bearer YOUR_FILMO_API_KEY' } })Pythonimport requests requests.get( "https://app.filmo.io/api/v1/incidents/inci_8f2a1c", headers={ "Authorization": "Bearer YOUR_FILMO_API_KEY" } )

{
  "data": {
    "id": "incident_9f3a2b",
    "identifier": "Example identifier",
    "title": "Example title",
    "description": "Example text.",
    "type": "Example type",
    "scope": "item",
    "status": "Example status",
    "priority": "Example priority",
    "severity": "Example severity",
    "blocksAvailability": true,
    "affectedQuantity": 1,
    "itemId": "item_9f3a2b",
    "serializedItemId": "serialized_item_9f3a2b",
    "spaceId": "space_9f3a2b",
    "vehicleId": "vehicle_9f3a2b",
    "orderId": "order_9f3a2b",
    "projectId": "project_9f3a2b",
    "dueDate": "2026-09-01T08:00:00.000Z",
    "commentCount": 1,
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}

// No body.

{
  "type": "https://docs.filmo.io/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Missing Authorization header: Bearer <api key>",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/addon_required",
  "title": "Add-on required",
  "status": 402,
  "code": "addon_required",
  "detail": "Your plan does not include the add-on this operation requires",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredAddon": "incidence"
}

{
  "type": "https://docs.filmo.io/errors/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "The API key does not have the required scope (orders:write)",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredScope": "incidents:read"
}

{
  "type": "https://docs.filmo.io/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Resource not found",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Rate limit exceeded: retry in 30 seconds",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "retryAfter": 30
}

{
  "type": "https://docs.filmo.io/errors/internal_error",
  "title": "Internal error",
  "status": 500,
  "code": "internal_error",
  "detail": "Internal error",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

Generated from the schema

It does NOT include the repair cost or the internal resolution note.

Authorizations

Bearer API key with the scope below. incidents:read

Headers

If-None-Matchstring

Conditional read: the ETag of the copy you already have. If the resource has not changed, the response is 304 with no body.

Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Path parameters

incidentIdstringRequired

Incident identifier.

Limits: min length 1

Response

application/json

Successful response.

Response schema: IncidentDto

Envelope: IncidentResponse. meta.warnings is present only when the operation is deprecated.

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag

dataobject

Broken, lost or malfunctioning material, with its repair status.

Show child attributes

data.idstring

Unique incident identifier.

data.identifierstring

Human-readable incident number.

data.titlestring

Short title of the incident.

data.descriptionstring | null

Description; null if it has none.

data.typestring

Nature: damage, loss, malfunction, cosmetic, theft or custom.

data.scopestring

What it affects: item, serializedItem, space, kit, vehicle or custom.

Available options: item, serializedItem, space, kit, vehicle, custom

data.statusstring

Lifecycle status: draft, open, waiting, repairing, complete or lost.

data.prioritystring

Priority: urgent, high, medium, low or none.

data.severitystring

Declared severity.

data.blocksAvailabilityboolean

true when the incident removes the material from the available pool.

data.affectedQuantityinteger | null

Affected units in bulk stock; null when not applicable.

data.itemIdstring | null

Affected item; null if not applicable.

data.serializedItemIdstring | null

Affected physical unit; null if not applicable.

data.spaceIdstring | null

Affected space; null if not applicable.

data.vehicleIdstring | null

Affected vehicle; null if not applicable.

data.orderIdstring | null

Order in which it was detected; null if not applicable.

data.projectIdstring | null

Associated project; null if not applicable.

data.dueDatestring<date-time> | null

Target resolution date in ISO 8601 UTC; null if it has none.

data.commentCountinteger

Comments the incident has.

data.createdAtstring<date-time>

Creation date in ISO 8601 UTC.

data.updatedAtstring<date-time>

Last modification date in ISO 8601 UTC.

metaobject

Additional information about the response.

Show child attributes

meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes

meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

meta.warnings.linkstring

Where the deprecation is documented (the changelog).

Errors

Status	Codes	Meaning
402	`addon_required`	The account plan does not include the add-on this operation needs; `requiredAddon` names it.
404	`not_found`	It does not exist or is outside the scope of the API key.

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy

Operations
Incident
Broken, lost or malfunctioning material, with its repair status.

Was this page helpful?

Request examples

Authorizations

Headers

Path parameters

Response

Errors

Deprecation

Related

Related pages

Incident