Filmo Docs
Español

Items

List serialized items

Returns the specific physical units of the inventory with their serial number, their status and which order they are committed to right now.

GET
/api/v1/serialized-items

Request examples

curl https://app.filmo.io/api/v1/serialized-items \
  --header "Authorization: Bearer $FILMO_API_KEY"
{
  "data": [
    {
      "id": "serialized_item_9f3a2b",
      "code": "Example code",
      "serialNumber": "2026-0001",
      "status": "Example status",
      "condition": "Example condition",
      "inventoryType": "Example inventory type",
      "itemId": "item_9f3a2b",
      "itemName": "Example item name",
      "itemSku": "Example item sku",
      "variantId": "variant_9f3a2b",
      "variantName": "Example variant name",
      "currentOrderId": "current_order_9f3a2b",
      "currentOrderNumber": "2026-0001",
      "projectId": "project_9f3a2b",
      "contactId": "contact_9f3a2b",
      "createdAt": "2026-09-01T08:00:00.000Z",
      "updatedAt": "2026-09-01T08:00:00.000Z"
    }
  ],
  "pagination": {
    "nextCursor": "eyJvIjoyMH0",
    "hasMore": true,
    "total": 1
  }
}

Generated from the schema

Filter by itemId to keep those of one catalog item. It is the piece that lets an external system know which unit is where. It emits no purchase prices or supplier agreements.

Authorizations

Bearer API key with the scope below. items: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 resource 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 resource 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 resource 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 resource 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 resource 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})?))?$

updatedOnstring

The last update date of the resource 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})?))?$

updatedAfterstring

The last update date of the resource 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})?))?$

updatedBeforestring

The last update date of the resource 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})?))?$

updatedFromstring

The last update date of the resource 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})?))?$

updatedTostring

The last update date of the resource 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: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: createdAt, updatedAt, code, serialNumber, status, condition, itemName. 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

itemIdstring

Filter by catalog item: returns only its physical units.

Limits: min length 1, max length 100

itemIdsstring[]

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

Limits: min 1 items, max 50 items, each min length 1, each max length 100

spaceIdstring

Filter by warehouse or space where the unit is located.

Limits: min length 1, max length 100

spaceIdsstring[]

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

Limits: min 1 items, max 50 items, each min length 1, each max length 100

statusstring

Filter by unit status. If omitted, all are returned.

Available options: available, prepared, picked_up, returned, broken, archived, sold

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: available, prepared, picked_up, returned, broken, archived, sold

Limits: min 1 items, max 50 items

inventoryTypestring

Filter by inventory type: "regular" is own stock, "temporary" is stock brought in for a specific job (subrent). If omitted, both are returned.

Available options: regular, temporary

inventoryTypesstring[]

Filter by inventoryType, 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: regular, temporary

Limits: min 1 items, max 50 items

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: SerializedItemDto

Envelope: SerializedItemList. 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 identifier of the physical unit.

data.codestring

Internal code of the unit.

data.serialNumberstring | null

Manufacturer serial number; null if not registered.

data.statusstring

Current status of the unit within the inventory cycle.

data.conditionstring | null

Condition; null if not assessed.

data.inventoryTypestring

"regular" for own stock, "temporary" for stock brought in for a specific job.

data.itemIdstring

Identifier of the catalog item this unit belongs to.

data.itemNamestring

Name of the catalog item.

data.itemSkustring | null

SKU of the item; null if it has none.

data.variantIdstring | null

Variant identifier; null if the item has no variants.

data.variantNamestring | null

Variant name; null if not applicable.

data.currentOrderIdstring | null

Order that holds the unit once it is prepared, picked up, sold or returned; null otherwise. A unit that is only reserved on an order is not committed yet: it stays available and this is null (the reservation is read from the serial numbers of the order line).

data.currentOrderNumberstring | null

Number of that order; null if the unit is free.

data.projectIdstring | null

Project associated with the current order; null if not applicable.

data.contactIdstring | null

Customer of the current order; null if not applicable.

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

StatusCodesMeaning
400validation_errorMalformed query or body. errors[] lists every offending field with its stable code.

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

Related

Related pages

Link to this section: Related pages

  • Catalog & inventory

    Serialized item

    Specific physical unit of an item, with its serial number and where it is.

Was this page helpful?

Cookies

If you accept, we use Google cookies to measure visits and show you ads. Privacy policy

More information

With your consent we use Google Ads and Google Analytics cookies to measure which campaigns bring visitors and requests, and to show you Filmo ads on other sites. Without acceptance, Google receives cookieless measurement signals, including your IP address, browser information and a cleaned page URL. Your choice is shared with the Filmo app.