Search

Global search over a Meilisearch-indexed entity

Searches the Meilisearch index for the given entity type and returns matching items (capped at 100), with entity-specific filtering, permission checks, and optional relationship loading applied.

get/api/search/{indexed_entity}

Request

Path parameters

indexed_entity'agency' | 'brand' | 'property' | 'contact' | 'user' | 'league' | 'category' | 'market' | 'organization' | 'venue' | 'subcategory' | 'genre' | 'subgenre' | 'asset' required

Indexed entity to search

Query parameters

search_termstring required

Term to search the Meilisearch index for

with_relationshipsstring[]

Relationships to eager-load on the results. Only the relationships allowed for the searched index are accepted

team_type_idinteger

Filter property results by team type

excluded_idinteger[]

IDs to exclude from the results

with_deletedboolean

Include soft-deleted records

is_parentboolean

Filter brands/properties by parent vs child

is_contact_ofinteger

Restrict contacts to those belonging to the given entity id

brand_typo_toleranceboolean

Use the brand index with typo tolerance

organization_accessstring[]
linkedin_urlstring
emailstring email
for_primary_profileboolean
for_secondary_profileboolean
with_organization_usersboolean
show_secondary_profilesboolean

Response

The matching indexed items and a total count.

totalinteger

Changes

No recorded changes to this operation across all 2 revisions of this API.