POST
/
search

Gets an object in bulk via a filter.

python example
response = requests.post(
    f"{url}/search",
    headers={
        'lume-api-key': '<api-key>'
    },
    json={
        'model': 'pipeline',
        'params': {
            'name': 'ordered'
        }
    }
)

Authorizations

​
lume-api-key
string
headerrequired

Query Parameters

​
page
integer
default: 1

Page number

Required range: x > 1
​
size
integer
default: 50

Page size

Required range: 1 < x < 100

Body

application/json
​
model
enum<string>
required

The model you want to search

Available options:
user,
pipeline,
job,
workshop,
result,
mapping,
target_schema
​
params
object | null

The parameters you want to search by. For non-id fields, the search returns results that contain the search term.

Response

200 - application/json
​
items
any[]
required
​
total
integer | null
required
Required range: x > 0
​
page
integer | null
required
Required range: x > 1
​
size
integer | null
required
Required range: x > 1
​
pages
integer | null
Required range: x > 0