Skip to main content
GET
/
api
/
users
List users
curl --request GET \
  --url https://{tenant}/api/users \
  --header 'Authorization: Bearer <token>'
{
  "pages": 1,
  "users": [
    {
      "access_key": "d7ebef749e4348cb67fec3cfc81f0a50",
      "active": true,
      "api_model": {},
      "created_at": "2024-05-19T08:23:29.173+03:00",
      "email_address": "multi-org-user@example.org",
      "first_name": "Multi org",
      "group_id": "",
      "id": "363634393863643165326663643130303031383465636235",
      "last_login_date": "2024-05-19T08:45:09.53319+03:00",
      "last_name": "User",
      "org_id": "5e9d9544a1dcd60001d0ed20",
      "password_max_days": 0,
      "password_updated": "2024-05-19T08:23:29.281+03:00",
      "user_permissions": {
        "IsAdmin": "admin",
        "ResetPassword": "admin"
      }
    },
    {
      "access_key": "f4b94c64017043dc4d1918db7e3436dd",
      "active": true,
      "api_model": {},
      "created_at": "2024-05-19T08:23:29.034+03:00",
      "email_address": "admin-user@example.org",
      "first_name": "Admin",
      "group_id": "",
      "id": "363634393863643165326663643130303031383465636234",
      "last_login_date": "2024-05-19T08:42:22.659839+03:00",
      "last_name": "User",
      "org_id": "5e9d9544a1dcd60001d0ed20",
      "password_max_days": 0,
      "password_updated": "2024-05-19T08:23:29.146+03:00",
      "user_permissions": {
        "IsAdmin": "admin",
        "ResetPassword": "admin"
      }
    },
    {
      "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"
      }
    },
    {
      "access_key": "b26feb8ff86b48e15ae2513a2de6f8f7",
      "active": true,
      "api_model": {},
      "created_at": "2024-05-19T09:14:13.461142+03:00",
      "email_address": "munene@gmail.com",
      "first_name": "munene",
      "group_id": "6649986d5715ec4c96cbef2b",
      "id": "363634393938623535373135656334633936636265663263",
      "last_login_date": "2024-05-19T08:45:09.53319+03:00",
      "last_name": "wachira",
      "org_id": "5e9d9544a1dcd60001d0ed20",
      "password_max_days": 0,
      "password_updated": "2024-05-19T09:14:13.461142+03:00",
      "user_permissions": {
        "analytics": "read",
        "api_assets": "write",
        "apis": "write",
        "certs": "write",
        "hooks": "write",
        "idm": "write",
        "keys": "write",
        "log": "read",
        "oauth": "write",
        "policies": "write",
        "portal": "write",
        "system": "write",
        "user_groups": "write",
        "users": "write",
        "websockets": "read"
      }
    }
  ]
}

​
Query Structure

query($filter: SubdomainUserFilterType) {
  subdomain_users {
    all(filter: $filter) {
      edges {
        node {
          id
          user {
            id
            email
            first_name
            last_name
          }
        }
      }
    }
  }
}

​
Filter Argument

All filters are passed inside the filter argument. Each filter field accepts an input object with operators: 
{
  "filter": {
    "user_email": {
      "ilike": "john"
    }
  }
}

​
Available Filters

FilterInput TypeOperatorsDescription
user_emailStringInputTypeeq, ilike, like, in, betweenUser email
user_nameStringInputTypeeq, ilike, like, in, betweenUser name

​
Filter Operators

Input TypeOperators
StringInputTypeeq (exact), ilike (case-insensitive partial), like (case-sensitive partial), in (array match), between (range)
IntegerInputTypeeq, gt, gteq, lt, lteq, between
DatetimeInputTypeeq, from, to, between
BooleanInputTypeeq (required)
IdInputTypeeq, gt, gteq, lt, lteq, in, filled
More fields and filters available via GraphQL introspection.

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.

Response

Users retrieved successfully.

​
pages
integer
​
users
object[] | null