POST
/
api
/
users
/
search
Search user with email.
curl --request POST \
  --url https://{tenant}/api/users/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filters": {
    "query": "itachi@tyk.io"
  }
}'
{
  "pages": 1,
  "users": [
    {
      "access_key": "d19fc75cd3aa497f6cb042f72e47ce8c",
      "active": true,
      "api_model": {},
      "created_at": "2024-05-19T08:45:09.53319+03:00",
      "email_address": "itachi.w@tyk.io",
      "first_name": "sasuke",
      "group_id": "",
      "id": "363634393931653535373135656334633936636265663261",
      "last_login_date": "2024-05-19T08:45:09.53319+03:00",
      "last_name": "itachi",
      "org_id": "5e9d9544a1dcd60001d0ed20",
      "password_max_days": 0,
      "password_updated": "2024-05-19T08:45:09.53319+03:00",
      "user_permissions": {
        "IsAdmin": "admin"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The Tyk Dashboard API Access Credentials

Query Parameters

​
p
integer

Use p query parameter to say which page you want returned. Send number less than 0 to return all items.

Body

application/json

User search criteria.

​
filters
object

Response

User searched.

​
pages
integer
​
users
object[] | null