Incidents

List incidents

Returns the incidents of the account, cursor-paginated: broken, lost or malfunctioning material with its repair status.

GET

/api/v1/incidents

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

Node.jsfetch('https://app.filmo.io/api/v1/incidents', { headers: { Authorization: 'Bearer YOUR_FILMO_API_KEY' } })Pythonimport requests requests.get("https://app.filmo.io/api/v1/incidents", 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"
    }
  ],
  "pagination": {
    "nextCursor": "eyJvIjoyMH0",
    "hasMore": true,
    "total": 1
  }
}

{
  "type": "https://docs.filmo.io/errors/validation_error",
  "title": "Validation error",
  "status": 400,
  "code": "validation_error",
  "detail": "2 validation errors",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "errors": [
    {
      "path": "name",
      "code": "too_small",
      "message": "Must be at least 1 characters long"
    },
    {
      "path": "contactType",
      "code": "invalid_value",
      "message": "Value not allowed; expected company, person"
    }
  ]
}

{
  "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/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

Filter by status, nature, scope, priority, severity, availability impact, affected resource, order, project, assignee, creation date and target resolution date. Sorted by creation date, newest first; sort accepts a single field. Repair costs, resolution notes and whether the cost is charged to the client are not published. Behind the incidence add-on: without it, 402.

Authorizations

Bearer API key with the scope below. incidents:read

Query parameters

limitintegerdefault:50

Page size (1-500). Defaults to 50.

Limits: min 1, max 500

cursorstring

Opaque cursor of the page to return. Pass the value of pagination.nextCursor from the previous response; treat it as opaque.

Limits: max length 200

createdOnstring

The creation date of the incident falls on this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

createdAfterstring

The creation date of the incident is after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

createdBeforestring

The creation date of the incident is before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

createdFromstring

The creation date of the incident is on or after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

createdTostring

The creation date of the incident is on or before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

sortstring

Sort order: a single field, with a leading "-" for descending (e.g. "-updatedAt"). Sortable fields: createdAt, updatedAt, dueDate, identifier, title, status, priority. Defaults to "-createdAt". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with.

Limits: max length 200

statusstring

Filter by lifecycle status: draft, open, waiting, repairing, complete or lost.

Available options: draft, open, waiting, repairing, complete, lost

statusesstring[]

Filter by status, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.

Available options: draft, open, waiting, repairing, complete, lost

Limits: min 1 items, max 50 items

typestring

Filter by nature: damage, loss, malfunction, cosmetic, theft or custom.

Available options: damage, loss, malfunction, cosmetic, theft, custom

typesstring[]

Filter by type, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.

Available options: damage, loss, malfunction, cosmetic, theft, custom

Limits: min 1 items, max 50 items

scopestring

Filter by what it affects: item, serializedItem, space, kit, vehicle or custom.

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

scopesstring[]

Filter by scope, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.

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

Limits: min 1 items, max 50 items

prioritystring

Filter by priority: urgent, high, medium, low or none.

Available options: urgent, high, medium, low, none

prioritiesstring[]

Filter by priority, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.

Available options: urgent, high, medium, low, none

Limits: min 1 items, max 50 items

severitystring

Filter by severity: low, high or blocking.

Available options: low, high, blocking

severitiesstring[]

Filter by severity, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.

Available options: low, high, blocking

Limits: min 1 items, max 50 items

blocksAvailabilityboolean

Filter by availability impact: "true" only incidents that remove the material from the available pool, "false" only those that do not. Omit it to apply no filter.

itemIdstring

Filter by affected item.

Limits: min length 1, max length 100

serializedItemIdstring

Filter by affected physical unit.

Limits: min length 1, max length 100

spaceIdstring

Filter by affected space.

Limits: min length 1, max length 100

vehicleIdstring

Filter by affected vehicle.

Limits: min length 1, max length 100

orderIdstring

Filter by the order in which it was detected.

Limits: min length 1, max length 100

projectIdstring

Filter by associated project.

Limits: min length 1, max length 100

assigneeStaffIdstring

Filter by assigned staff member (the same identifier that assigneeStaffIds takes when writing).

Limits: min length 1, max length 100

dueOnstring

The target resolution date of the incident falls on this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

dueAfterstring

The target resolution date of the incident is after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

dueBeforestring

The target resolution date of the incident is before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

dueFromstring

The target resolution date of the incident is on or after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

dueTostring

The target resolution date of the incident is on or before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

includeTotalbooleandefault:false

Set it to true to include pagination.total, the number of results that match the filters across all pages. Off by default.

Response

application/json

Successful response.

Response schema: IncidentDto

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

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

dataobject[]

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.

paginationobject

Opaque-cursor pagination metadata.

Show child attributes

pagination.nextCursorstring | null

Opaque cursor of the next page; null when there are no more results. Pass it as cursor in the next request.

pagination.hasMoreboolean

Whether more results exist beyond this page.

pagination.totalinteger

Number of results matching the filters across all pages. Present only when the request sets includeTotal=true.

Limits: min 0

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
400	`validation_error`	Malformed query or body. `errors[]` lists every offending field with its stable code.
402	`addon_required`	The account plan does not include the add-on this operation needs; `requiredAddon` names it.

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

Query parameters

Response

Errors

Deprecation

Related

Related pages

Incident