Skip to main content
GET
/
api
/
v1
/
users
/
search
/
Search Users
curl --request GET \
  --url https://next-fast-turbo-api.vercel.app/api/v1/users/search/
{
  "results": [
    {
      "id": "<string>",
      "forename": "<string>",
      "surname": "<string>",
      "email": "jsmith@example.com"
    }
  ]
}

Query Parameters

​
search_on
enum<string>
default:email
Available options:
id,
email,
forename,
surname
​
keyword
​
max_results
integer | null
default:10

Response

Successful Response

​
results
User · object[]
required