Skip to content

Search entities

GET
/search
curl --request GET \
--url 'https://shoehorn.example.com/api/v1/search?q=example&limit=20'

Full-text search across all catalog entities using Meilisearch.

q
required
string

Search query (supports fuzzy matching)

type
string

Filter by entity type

lifecycle
string
owner
string
limit
integer
default: 20

Search results

Media type application/json
object
results
Array<object>
object
id
string
service_id
string
name
string
type
string
description
string
owner
string
lifecycle
string
score

Relevance score

number
total
integer
query
string
processing_time_ms
integer
Example generated
{
"results": [
{
"id": "example",
"service_id": "example",
"name": "example",
"type": "example",
"description": "example",
"owner": "example",
"lifecycle": "example",
"score": 1
}
],
"total": 1,
"query": "example",
"processing_time_ms": 1
}