Convenience
Search
Perform a search based on the provided parameters
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
Authorization
string
headerrequiredThe access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
page
integer
default: 1Page number
size
integer
default: 50Page size
Body
application/json
model
enum<string>
requiredThe 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[]
requiredtotal
integer | null
requiredpage
integer | null
requiredsize
integer | null
requiredpages
integer | null