GET
/
api
/
entities
/
v1
/
search
SearchEntities
curl --request GET \
  --url https://developer.synq.io/api/entities/v1/search \
  --header 'Authorization: Bearer <token>'
{
  "hits": [
    {
      "name": "<string>",
      "description": "<string>",
      "entityId": "<any>",
      "synqPath": "<string>",
      "entityType": "ENTITY_TYPE_UNSPECIFIED",
      "rankingScore": 123
    }
  ],
  "estimatedTotalHits": 123,
  "entityTypeEstimates": [
    {
      "entityType": "ENTITY_TYPE_UNSPECIFIED",
      "count": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
query
string
required

Full text search query, it will search in name but also in description and columns of the entities

Minimum length: 1
​
limitToTypes
enum<string>[]

Limit results to specific entity types, leave empty to use only the query

​
page
integer
​
limitPerPage
integer

Response

200 - application/json

Success

The response is of type object.