Skip to content
  • api
  • search

Search

PhantomJSON supports full-text search across multiple fields using the q query parameter.

Syntax

Section titled “Syntax”
Terminal window
?q=searchterm

Example

Section titled “Example”
Terminal window
curl "https://api.phantomjson.app/v1/users?q=john"

Behavior

Section titled “Behavior”
  • Case-insensitive substring match
  • Searches across multiple fields per resource
  • Matches partial words

Searchable Fields

Section titled “Searchable Fields”
Resource Searchable Fields
Users firstName, lastName, email
Posts title, body
Comments name, body
Todos title
Albums title
Photos title
Products name, description

Examples

Section titled “Examples”

Search Users

Section titled “Search Users”
Terminal window
# Search by name
curl "https://api.phantomjson.app/v1/users?q=john"


# Search by email
curl "https://api.phantomjson.app/v1/users?q=example"

Search Posts

Section titled “Search Posts”
Terminal window
curl "https://api.phantomjson.app/v1/posts?q=react"

Search Products

Section titled “Search Products”
Terminal window
curl "https://api.phantomjson.app/v1/products?q=iphone"

Combining with Other Parameters

Section titled “Combining with Other Parameters”

Search works with pagination, filtering, and sorting:

Terminal window
# Search + pagination
curl "https://api.phantomjson.app/v1/users?q=john&page=1&limit=10"


# Search + filter
curl "https://api.phantomjson.app/v1/products?q=phone&category=smartphones"


# Search + sort
curl "https://api.phantomjson.app/v1/users?q=john&sort=firstName:asc"