AviatoAviato
DeveloperAPI ReferenceEntitiesSearch

/api/entities/search

GET
/api/entities/search

Query Parameters

q*string

Search query

Length1 <= length
type?string

Filter by entity type

limit?integer

Max entities to return

Range0 < value
includeHidden?|

Include entities marked hidden. Honored only with an active Aviato Afterburner license.

Response Body

application/json

curl -X GET "https://example.com/api/entities/search?q=string"
{
  "entities": [
    {
      "id": "string",
      "type": "string",
      "name": "string",
      "status": "pending",
      "sourcePluginId": "string",
      "searchTerms": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "assets": {
        "property1": "string",
        "property2": "string"
      },
      "assetAspects": {
        "property1": "string",
        "property2": "string"
      }
    }
  ]
}