Skip to content

GET /serial

Search Serials

GET
/serial

Search serials with rich filtering and sorting.

Executes the FIND_SERIALS AQL query with the full set of filter parameters.
Wildcard search fields (serial_search, product_code_search, etc.) accept
shell-style wildcards (*, ?) which are converted to AQL regex before
execution. advanced_filters accepts a base64-encoded JSON array of custom
field filters.

Emits: (direct query — no event class)
Required scope: serial:read

Authorizations

OAuth2PasswordBearer
password Flow
Token URL"/api/auth"
Scopes:
  • "admin"User can access and edit users and system settings
  • "library"User can access and edit products
  • "production"User can access and edit production plans
  • "operator"User can access the operator panel and make production declarations

Parameters

Query Parameters

serial_key
serial_search
is_contained_in
contains
time_created_from
time_created_to
created_by
advanced_filters
Type
string
product_key
product_code_search
work_order_search
project_search
limit
Default
200
include_deleted
Type
boolean
Default
false
offset
filter_unreleased
Type
boolean
Default
false
time_released_from
time_released_to
sort_by
Default
"created"
sorting_order
Default
"desc"

Responses

Successful Response

application/json
JSON
[
]

Samples

Powered by VitePress OpenAPI

Released under the Apache 2.0 License.