Perform a search query

get

https://api.readme.com/v2/search

Searches the ReadMe project.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

query

string

required

The plain text search query used to search across the project.

include_breadcrumbs

string

enum

Include category and page titles, and the page icon, for each result when available.

Allowed:

section

string

The section of your ReadMe project to search within. If omitted, all enabled sections are searched.

version

string

The version to search within. For enterprise, this only applies to the current project.

projects

array of strings

Limit search to only these projects in an Enterprise group. If omitted, all child projects with the appropriate permissions are searched. This parameter is only applicable to Enterprise projects.

projects

page

number

≥ 1

Defaults to 1

Used to specify further pages (starts at 1). The product of page and per_page may not exceed 1000.

per_page

number

1 to 50

Defaults to 15

Number of items to include in pagination (up to 50).

include_counts

string

enum

Return section_hit_counts alongside the results: how many matches this query has in each section. Cannot be combined with section, which narrows the query the counts describe.

Allowed:

Headers

x-readme-subdomain

string

The project subdomain. Required with an OAuth token. With an API key, must match the key’s project if supplied.

Response

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK