v1

latestOpenAPI 3.0.32026-07-17291237.2 KB
Search

Search index

Execute a search query against the specified index. Note: annotation index requires admin privileges.

post/api/v3/search/{indexName}

Path parameters

indexName'encounter' | 'individual' | 'occurrence' | 'annotation' | 'sighting' | 'user' required

Name of the index to search

Query parameters

frominteger

Pagination offset

sizeinteger

Number of results to return

sortstring

Sort field

sortOrder'asc' | 'desc'

Sort order

Request body

SearchQuery required

OpenSearch/Elasticsearch query body

Response

Search results

successboolean
searchQueryIdstring uuid
hitsobject[]
querySearchQuery

OpenSearch/Elasticsearch query body