Searching For Articles

GET /search[?query&limit] Get the top search results for a given string. Arguments Description query ​​ string Required The search term string you'd like results for limit int How many results you'd…

River Sloane
Updated by River Sloane

GET /search[?query&limit]

Get the top search results for a given string.

Arguments

Description

query

​​string

Required

The search term string you'd like results for

limit

int

How many results you'd like to receive

Default: 10, Max: 100

include_private

bool

Include articles with a private status in the results. Set to true to include

include_draft

​bool

Include articles with a draft status in the results. Set to true to include

language_code

string

If you have multilingual enabled, this will be the ISO language code you're trying to search in (e.g. fr, en, etc.). If you don't send this we'll search in your account's default language.

Example response:

{
    "articles": [ Article ]
}

How did we do?

Contact